Blueprint File
Each Resolve Actions Pro component is configurable and has to be customized according to the specific architecture and environment. Actions Pro components are managed through a Blueprint file which contains configuration settings for all components:
- Each core server with Actions Pro installed has its own Blueprint file located in
<actions-pro-home>/rsmgmt/config/blueprint.properties
with a symlink to it in <actions-pro-home>/bin/
.
The properties of this file are detailed in the current document. - Each standalone RSRemote deployment has its own Blueprint file located in
<actions-pro-home>/rsmgmt/config/blueprint.properties
.
The properties of this file are detailed in ::title.
The Blueprint file contains configuration settings for all Actions Pro components. The first section of the Blueprint contains installation parameters that need to be set before installing Actions Pro. After installation, you may need to modify the Blueprint file to optimize or customize Actions Pro for your particular environment.
In a clustered deployment, the connection settings need to be the same between Blueprint files. Other settings, such as gateway configurations, may be set individually between Blueprint files.
Blueprint Syntax
The following is special syntax used in the blueprint.properties
file. They are mostly used to change the value of properties before being applied to the local Actions Pro environment (i.e., encrypting values or referencing other property values).
Reserved Variables
The following Variables are reserved by the Blueprint and cannot be overwritten.
${DIST}
—Installation Directory of Actions Pro
Syntax
The following table describes the syntax of the Blueprint.
Item | Description |
---|
# | Used at the start of a line to add a comment. |
${} | Reference to other parameters in the Blueprint; for example, ${PRIMARY} will reference the value of PRIMARY . |
ENC: | Deprecated. A value encrypted with an older encryption method. |
ENC1: | An encrypted value; by default, all non-reference, plain text password fields will be encrypted after running config.sh/config.bat . |
NO_ENC: | Used to leave a password field unencrypted or as plain text; for example, DB_PASSWORD=NO_ENC:resolve will be left as is after config, even though it is a password field. |
TO_ENC: | Used to specify a value that needs to be encrypted after running config.sh/config.bat which is not normally encrypted; for example, rsmq.username=TO_ENC:resolve after config.sh /config.bat is run becomes rsmq.username=ENC1:encrypted text . |
Modifying the Blueprint and Re-configuring RSRemote
The file is named blueprint.properties
and is located in the <installPath>/rsmgmt/config
directory. In UNIX environments, there is a softlink to this file in the bin directory.
Do not remove the blueprint.properties file located in the rsmgmt/config directory! Your Actions Pro installation will not operate without this file.
When setting up the blueprint file, use a forward slash /
instead of a backslash \
. If you do use a backslash, double it \\
because Java treats the single backslash as an escape.
If you make a mistake configuring the JAVA_HOME
variable, it can not be fixed.
Modifying the Blueprint
You can edit the Blueprint file using any text editor. The Blueprint file contains simple name=value pairs. These configuration options are described in detail in other sections.
Applying the Blueprint Configuration
Actions Pro must be reconfigured using the modified Blueprint before changes will take effect.
- Stop all Actions Pro processes whose configurations are being changed.
- Modify the
blueprint.properties
file for the new configuration. - Run the config.sh file, located in
<installPath>/bin/
by using the following:
bin/config.sh
- After the configuration script completes, restart Actions Pro.
Required Settings
The following settings are required for the Actions Pro installation. For standalone systems, the loopback address of 127.0.0.1 can be used, but if the standalone instance will be clustered at a later date, then it is better to use a valid IP or hostname.
Property | Description | Default Value |
---|
PRIMARY | Whether the machine is the Primary machine. The Primary machine creates DB tables and RSSearch indices and gathers Reporting metrics.
When doing a standalone installation, ensure that this is set to true . | true |
CLUSTERNAME | Name of the RSSearch cluster. Set it to be the same between all machines.
Must be unique for a deployment (e.g., PRODUCTION, DEVELOPMENT, TESTING). | RESOLVE |
SERVER_ID | The ID for the local server. | 1 |
LOCALHOST | The hostname or IP address of the local server.
Change to the actual IP address or hostname of the machine.
The value is automatically set to the output of the hostname OS command if left blank. | 127.0.0.1 |
RSVIEW_NODES | Comma-separated list of the hostnames or IP addresses of all nodes running RSView, including the local machine if the component runs on it.
Preferably, keep the list order the same between each node’s Blueprint.
For standalone installations, set to the IP of the local machine. | 127.0.0.1 |
RSSEARCH_NODES | Comma-separated list of the hostnames or IP addresses of all nodes running RSSearch, including the local machine if the component runs on it.
Preferably, keep the list order the same between each node’s Blueprint.
For standalone installations, set to the IP of the local machine. | ${RSVIEW_NODES} |
RSCONTROL_NODES | Comma-separated list of the hostnames or IP addresses of all nodes running RSControl, including the local machine if the component runs on it.
Preferably, keep the list order the same between each node’s Blueprint.
For standalone installations, set to the IP of the local machine. | 127.0.0.1 |
DB_TYPE | The type of the SQL database that you prepared to work with Actions Pro. Possible values: mysql , oracle | mysql |
DB_HOST | Host name or IP of the machine where the SQL database is running. | 127.0.0.1 |
DB_USERNAME | Username for Actions Pro to use to connect to and write in the SQL DB. | resolve |
DB_PASSWORD | Password for DB_USERNAME. | resolve |
DB_NAME | The name of the SQL database for Actions Pro to use. | resolve |
DB_SCHEMA | The name of the SQL database schema to use. Leave blank to automatically use the DB_NAME (for MySQL) or DB_USERNAME (for Oracle). | |
DB_URL | JDBC URL to use to connect to the database. If left blank (not recommended), it will be generated from the DB_HOST and DB_NAME based on the DB_TYPE. For more complex cases, such as when enabling SSL, ensure that you have entered the full connection string. | No default
Example:
jdbc:oracle:thin:@//127.0.0.1:1521/resolve or jdbc:mysql://mysql.example.com:3306/my_database?useSSL=true&serverTimezone=UTC |
RSMQ_PRIMARY_HOST | The hostname or IP address of the RSMQ machine. For standalone installations, set to the IP of the local machine. | 127.0.0.1 |
RSMQ_PRIMARY_PORT | Port used by the RSMQ service. | 4004 |
RSMQ_BACKUP_HOST | Clustered installations only. The hostname or IP address of the Backup RSMQ node. | |
RSMQ_BACKUP_PORT | Clustered installations only. Port used by the Backup RSMQ service. | 4004 |
# Installed Components resolve.<component> | Choose which Actions Pro components to install on the current machine. You don’t need to change this section for a single-machine installation.
Components set to true will install on the current machine; components set to false will not. The reference to another property (e.g. ${PRIMARY} , ${resolve.rslog} ) will take the value of that property.
Components with *_NODES list properties are automatically set to false if the LOCALHOST property value is not found in the respective *_NODES list. | resolve.rscontrol=true resolve.rsremote=true resolve.rsview=true resolve.rsmq=true resolve.rsconsole=true resolve.rsmgmt=true resolve.rssearch=true resolve.rssync=false resolve.rslog=${PRIMARY} resolve.logstash=${resolve.rslog} resolve.kibana=${PRIMARY} resolve.rsvault=false resolve.rskeyservice=false |
Optional Settings
The following settings are optional to the configuration. These settings can be used to configure the resources available to the different components installed on this server.
Property | Description | Default Value |
---|
resolve.user | Linux user that Actions Pro will run under. | resolve |
rsmq.Xms | RSMQ minimum memory allocated in MB. | 256 |
rsmq.Xmx | RSMQ maximum memory allocated in MB. | 512 |
rscontrol.run.Xms | RSControl minimum memory allocated in MB. | 256 |
rscontrol.run.Xmx | RSControl maximum memory allocated in MB. | 1024 |
rsview.run.Xms | RSView minimum memory allocated in MB. | 256 |
rsview.run.Xmx | RSView maximum memory allocated in MB. | 1024 |
rsremote.run.Xms | RSRemote minimum memory allocated in MB. | 256 |
rsremote.run.Xmx | RSRemote maximum memory allocated in MB. | 512 |
rsremote.esb.queue.name.1 | Queue name that RSRemote will listen to. The queue will be created if it doesn’t exist.
You can add multiple RSRemote queues by duplicating the property with an increasing number (rsremote.esb.queue.name.2, rsremote.esb.queue.name.3, ...) and setting it to a different value. This can be useful if RSRemote needs to be targeted by specific tasks.
Alternatively, you can remove all queues if you want the RSRemote to only perform gateway functions. | RSREMOTE |
rsmgmt.run.Xms | RSMgmt minimum memory allocated in MB. | 64 |
rsmgmt.run.Xmx | RSMgmt maximum memory allocated in MB. | 512 |
rssearch.run.Xms | RSSearch minimum memory allocated in MB. | 4096 |
rssearch.run.Xmx | RSSearch maximum memory allocated in MB. | 4096 |
rssync.run.Xms | RSSync maximum memory allocated in MB. | 1024 |
rssync.run.Xmx | RSSync maximum memory allocated in MB. | 1024 |
logstash.run.Xms | RSLogstash maximum memory allocated in MB. | 1024 |
logstash.run.Xmx | RSLogstash maximum memory allocated in MB. | 1024 |
rsremote.run.ld_library_path | Full path to a .so library file needed for an ActionTask in RSRemote. | |
search.ttl | How long does Elasticsearch store files, in seconds. | 7776000 |
Recommended Additions & Database Updates
The following table shows the recommeded database-related settings.
Database Property | Recommended Value |
---|
rscontrol.jta.max_actives | 500 |
rsview.jta.max_actives | 1500 |
rscontrol.sql.maxpoolsize | 200 |
rsview.sql.maxpoolsize | 400 |
rsview.general.maxthread | 200 |
rscontrol.general.maxthread | 100 |
rsremote.general.maxthread | 500 |
rsmgmt.general.maxthread | 100 |
RSRemote Queue Names
RSRemote can be configured to listen to different AMQP queues. This allows tasks to target a specific RSRemote or sets of RSRemotes when necessary. For example, if a task needs to connect to a router that is only available to a certain RSRemote, that RSRemote can be configured to listen to a ROUTER queue. Or, if a task must be executed on a Windows machine, it can target only RSRemotes listening to the WINDOWS queue.
All RSRemote instances listen to the RSREMOTE queue (rsremote.esb.queue.name=RSREMOTE) by default. This is the queue used by all tasks that do not explicitly set a target queue. Also, any gateways set up on the RSRemote will listen on a specified queue.
Additional queues can be added to target specific RSRemotes with tasks by:
- Copying the rsremote.esb.queue.name.1 property and changing the value and number (e.g. rsremote.esb.queue.name.2=WINDOWS)
- Configuring gateways (Blueprint File - Gateways).
- Optionally, the value rsremote.esb.queue.name.1 can also be removed so the RSRemote will only listen to queues that are added automatically by gateways.
Multiple RSRemote queues can be added by:
- Copying the rsremote.esb.queue.name.1 property line.
- Incrementing the number (e.g. rsremote.esb.queue.name.2=NEWQUEUE).
This can be useful if the RSRemote needs to be targeted by specific tasks. Alternatively, all queues can be removed if the RSRemote should only perform gateway functions.
Encrypted Password Fields
Any field that is a password field is automatically encrypted after running the config.sh/config.bat file to apply the blueprint.properties file. The following syntax can be used to either force or skip encryption of properties in the Blueprint file:
Syntax | Description |
---|
#NO_ENC | Leaves the password field unencrypted, for example, DB_PASSWORD=NO_ENC:resolve |
#TO_ENC | Specifies a value that needs to be encrypted after running config.sh/config.bat; for example, rsmq.username=TO_ENC:resolve |
Reserved and Reference Variables
The following variables are reserved within Actions Pro and provide the values shown below. These variables cannot be set by the user or used as user-defined values.
The following table lists the Preprocessor variables.
Name | Description |
---|
LOG | Log object used to append to RSControl log |
DB | Database connection object |
ESB | Object used to send Messages through RSMQ |
PROCESSID | Process ID of Runbook execution |
PROBLEMID | Worksheet ID |
WIKI | Name of the Runbook wiki document page |
PARAMS | PARAM parameter map |
FLOWS | FLOW parameter map |
INPUTS | INPUT parameter map |
OUTPUTS | OUTPUT parameter map that contains OUTPUT variables set in the Assessor of previous task in the Runbook sequence |
GLOBALS | Object used to get and set GLOBAL variables |
The following table lists the Content (RSRemote) variables.
Name | Description |
---|
LOG | Log object used to append to RSControl log |
REFERENCE | External System Reference, for example, Netcool ServerName:ServerSerial:Serial |
PARAMS | PARAM parameter map |
FLOWS | FLOW parameter map |
INPUTS | INPUT parameter map |
PROBLEMID | Worksheet ID |
WIKI | Name of Runbook wiki document page |
SESSIONS | Object used to persist a connection in a Runbook |
The following table lists the Assessor variables.
Name | Description |
---|
ACTIONNAME | Name of ActionTask |
RAW | Raw results from an ActionTask |
DATA | Parsed raw data from the Parser |
DATATYPE | Type of parsed data (STRING, XML, MAP, LISTMAP) |
LOG | Log object used to append to RSControl log |
DB | Database connection object |
ESB | Object used to send messages through RSMQ |
PROCESSID | Process ID of Runbook execution |
EXECUTEID | Execute ID of an ActionTask |
PROBLEMID | Worksheet ID |
REFERENCE | External System Reference, for example, Netcool ServerName:ServerSerial:Serial |
WIKI | Name of the Runbook wiki document |
INPUTS | INPUT parameter map |
PARAMS | PARAM parameter map |
FLOW | FLOW parameter map |
RESULT | Results object that contains the ActionTask completion, condition, severity, summary, and detail |
OUTPUT | OUTPUT parameter map, for assessor it will be empty |
RECORD | Worksheet field hashmap to allow worksheet fields to be set |
GLOBALS | Object used to get and set GLOBAL variables |
Blueprint File Advanced Settings
The Blueprint file contains additional settings and values beyond those described in the Installation Guides. These values are listed here for reference.
Do not modify unless specifically instructed to by support.
RSMQ Settings
Property Name | Description | Default Value |
---|
rsmq.user | User to match against specified user during update and installation. | ${resolve.user} |
rsmq.primary.ipaddress | Primary ipaddress used by rsmq. | ${RSMQ_EXTERNAL_PRIMARY_HOST} |
rsmq.primary.port | Primary port used by rsmq. | ${RSMQ_EXTERNAL_PRIMARY_PORT} |
rsmq.backup.ipaddress | Backup ip address used by rsmq. | ${RSMQ_EXTERNAL_BACKUP_HOST} |
rsmq.backup.port | Backup port used by rsmq. | ${RSMQ_EXTERNAL_BACKUP_PORT} |
rsmq.username | Username set for rabbitmq. | admin |
rsmq.password | Password set for rabbitmq. | resolve |
rsmq.management.port | Port that RabbitMQ's management plugin runs on. | 15672 |
rsmq.epmd.port | Port used by epmd. | 4369 |
rsmq.inet.port | Port used by inet. | 35197 |
rsmq.product | Product used byrs. | RABBITMQ |
rsmq.primary.name | Name of the primary erlang node-and-machine combination. | ${rsmq.primary.ipaddress} |
rsmq.backup.name | Name of the backup erland node-and-machine combination. | ${rsmq.backup.ipaddress} |
rsmq.vhost | | / |
Blueprint Property | Default Value | Description |
---|
rssearch.shards | Configures the number of Elasticsearch shards per index. It is highly recommended that this value is set to 1. | 1 |
rssearch.lsm.rolloversize | Hot Phase setting. How many days old an index must be before rolling over. The value should be set such that the largest index (usually task results) never goes above 20GB before rolling over. The value may also be set to a size rollover by removing the “d” from the configuration (e.g. rssearch.lsm.rolloversize=20). | 7d |
rssearch.lsm.readonlydays | Warm Phase setting. How long, in days, after the index has rolled over before it is marked as read-only. If there are any runbooks using events that may go over 1 day this would need to be increased. May be set to 0 to turn off this phase. If using automation that takes longer than | 1 |
rssearch.lsm.freezedays | Cold Phase setting. How long, in days, after the previous phase the index is frozen. A frozen index will not be searched using an alias thereby reducing memory usage. Freezing the index requires a close and reopen during which the cluster will be “red”. So on high volume systems this may need to be turned off by setting the value to 0. | 30 |
rssearch.lsm.deletedays | Absolute Retention. How long, in days, after the previous phase the index is deleted. | 365 |
Property Name | Description | Default Value |
---|
rssearch.run.R_USER | Name of the Actions Pro user in Elasticsearch. | ${resolve.user} |
rssearch.run.terminatetimeout | How long does it take to an Elasticsearch request to timeout. | 30 |
rssearch.serverlist | List of all servers that have RSSearch installed on them. | ${RSSEARCH_NODES} |
rssearch.clienttype | Set whether clients should be node or transport. | transport |
rssearch.indexthreads | deprecаted | |
rssearch.indextimout | How long does it take to an index request to timeout. In seconds. | 120 |
rssearch.indexretries | Number of attempts to read or write to an index. | 5 |
rssearch.yml.network.bind_host | Host that the ES node will bind on. | ${LOCALHOST} |
rssearch.yml.network.host | Host that the ES node will bind and publish. | ${LOCALHOST} |
rssearch.yml.transport.tcp.port | Port that ES will bind for communication between nodes. | 9300 |
rssearch.yml.cluster.name | name used to discover and auto-join nodes | ${CLUSTERNAME} |
rssearch.yml.node.name | name used by ES to identify the name | ${LOCALHOST} |
rssearch.yml.http.port | port ES binds for http use | 9200 |
rssearch.yml.discovery.zen.ping.unicast.hosts | array or comma delimited, in the form of host:port or host, t | ${RSSEARCH_NODES} |
rssearch.yml.bootstrap.mlockall | set to true to lock the process address space into ram preventing elasticsearch memory from being swapped out | true |
rssearch.yml.cluster.initial_master_nodes | | ${RSSEARCH_NODES} |
rssearch.yml.bootstrap.memory_lock | | true |
rssearch.yml.reindex.remote.whitelist | | ${LOCALHOST}:*, localhost:* |
rssearch.unicast.hosts_port | deprecаted | |
rssearch.yml.discovery.zen.minimum_master_nodes | Sets the minimum number of master eligible nodes that are needed for an election to complete, If -1, will default to N/2 + 1 where N is the number of RSSEARCH_NODES. | 1 |
rssearch.yml.shield.http.ssl | Set to 'true' to enable ssl on communications between http clients and the cluster. | false |
rssearch.yml.shield.ssl.keystore.path | Full path to the node keystore file. | ${rsview.tomcat.connector.https.keystoreFile} |
rssearch.yml.shield.ssl.keystore.password | Password used to decrypt the keystore. | ${rsview.tomcat.connector.https.keystorePass} |
rssearch.yml.shield.ssl.keystore.key_password | Password entered at the end of the keytool -genkey command. | |
rssearch.yml.shield.transport.ssl | Set to 'true' to ensure encrypted communication between the nodes. | false |
rssearch.replicas | Number of copies owned by a shard. Set to -1 for each shard to have a copy on each node.If -1, will default to N/2 + 1where N is the number of RSSEARCH_NODES | 1 |
rssearch.sync | Set to 'true' to sync RSSearch nodes. | false |
rssearch.synccluster | Name of the remote cluster used for discovery. | ${RSSEARCH_SYNC_CLUSTERNAME} |
rssearch.syncserverlist | List of server nodes to sync. | ${RSSEARCH_SYNC_NODES} |
rssearch.syncserverlist | Port to sync RSSearch nodes over. | 9300 |
RSControl Settings
The following lists shows the logical groups of RSControl properties and their default values.
- RSControl config.xml general information
rscontrol.general.home=${DIST}
rscontrol.general.clustername=${CLUSTERNAME}
rscontrol.general.configfileversion=1.0
rscontrol.general.configrevisions=2
rscontrol.general.saveconfigonstart=true
rscontrol.general.saveconfigonexit=true
rscontrol.general.savecrononexit=false
rscontrol.general.cronoffset=0
rscontrol.general.scheduledpool=200
rscontrol.general.taskExecutor.executorAlarmThreadLimit=800
#groovy thread pool max size
rscontrol.general.scriptpool.scriptPoolAlarmThreadLimit=800
#we don't need results in the case where we want to get maximum performance
rscontrol.general.logActionResults=true
rscontrol.general.snmptraphost=
rscontrol.general.snmptrapport=162
rscontrol.general.threadkeepalive=30
rscontrol.general.perfdebug=false
rscontrol.general.executorbusyratio=0.9
rscontrol.general.sysexecutorbusyratio=0.9
rscontrol.general.startexecutorbusyratio=0.9
rscontrol.general.dbpoolbusyratio=0.9
rscontrol.general.maxrunbooklimit=400
rscontrol.general.minrunbooklimit=1
rscontrol.general.userunbookcount=false
rscontrol.general.mcpmode=${MCPMODE}
rscontrol.general.environment=${ENVIRONMENT}
rscontrol.general.runbookmetrics=false
rscontrol.general.enablerunbookstatcounters=true
rscontrol.general.isDcsEnabled=${resolve.dcs}
- RSControl Log4j configuration
rscontrol.log4j.Loggers.Root.level=WARN
rscontrol.log4j.Loggers.Root.appender-ref.ref=RSCONTROL
rscontrol.log4j.Loggers.Logger.com.resolve.rscontrol.level=${rscontrol.log4j.loglevel}
rscontrol.log4j.Loggers.Logger.com.mchange.v2.level=INFO
rscontrol.log4j.Loggers.Logger.org.quartz.level=ERROR
rscontrol.log4j.Loggers.Logger.syslog.level=ERROR
rscontrol.log4j.Loggers.Logger.syslog.additivity=false
rscontrol.log4j.Appenders.RollingFile.RSCONTROL.fileName=rscontrol/log/rscontrol.log
rscontrol.log4j.Appenders.RollingFile.RSCONTROL.filePattern=rscontrol/log/$\${date:yyyy-MM}/rscontrol-%d{MM-dd-yyyy}-%i.log.zip
rscontrol.log4j.Appenders.RollingFile.RSCONTROL.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
rscontrol.log4j.Appenders.RollingFile.RSCONTROL.SizeBasedTriggeringPolicy.size=32MB
rscontrol.log4j.Appenders.RollingFile.RSCONTROL.DefaultRolloverStrategy.max=30
- RSControl config.xml ESB information
rscontrol.esb.product=${rsmq.product}
rscontrol.esb.brokeraddr=${RSMQ_EXTERNAL_PRIMARY_HOST}:${RSMQ_EXTERNAL_PRIMARY_PORT}
rscontrol.esb.username=${rsmq.username}
rscontrol.esb.password=${rsmq.password}
rscontrol.esb.domain=domain1
rscontrol.esb.brokername=router1
rscontrol.esb.mgmtaddr=
rscontrol.esb.brokeraddr2=${RSMQ_EXTERNAL_BACKUP_HOST}:${RSMQ_EXTERNAL_BACKUP_PORT}
rscontrol.esb.createqueueretry=30
rscontrol.esb.createqueuewait=10
rscontrol.esb.keepalive=0
rscontrol.esb.maxfailed=10
rscontrol.esb.cachesize=500
scontrol.esb.flowcontrolstartqueuesize=400
rscontrol.esb.maxmessages=-1
rscontrol.esb.messagettl=1200000
rscontrol.esb.vhost=${rsmq.vhost}
- RSControl config.xml SQL information
rscontrol.sql.dbtype=${DB_TYPE}
rscontrol.sql.dbname=${DB_NAME}
rscontrol.sql.host=${DB_HOST}
rscontrol.sql.username=${DB_USERNAME}
rscontrol.sql.password=${DB_PASSWORD}
rscontrol.sql.url=${DB_URL}
rscontrol.sql.maxpoolsize=200
rscontrol.sql.minpoolsize=${rscontrol.sql.maxpoolsize}
rscontrol.sql.maxidletime=60
- RSControl key service configuration
rscontrol.keyservice.proto=${KEYSERVICE_PROTO}
rscontrol.keyservice.host=${KEYSERVICE_HOST}
rscontrol.keyservice.port=${KEYSERVICE_PORT}
rscontrol.keyservice.username=${KEYSERVICE_USERNAME}
rscontrol.keyservice.pwd=${KEYSERVICE_PWD}
- RSControl registration information
rscontrol.id.group=default
rscontrol.id.description=RSCONTROL
rscontrol.id.location=${LOCALHOST}
- Location of RSControl Groovy Scripts, executable from RSConsole commands
rscontrol.gse.path=${DIST}/RSControl/service
- RSControl Central registration configuration
rscontrol.registration.logheartbeat=true
- RSControl ehcache configuration
rscontrol.ehcache.defaultCache.maxElementsInMemory=10000
rscontrol.ehcache.defaultCache.eternal=true
rscontrol.ehcache.defaultCache.maxElementsOnDisk=10000000
rscontrol.ehcache.defaultCache.diskExpiryThreadIntervalSeconds=120
- RSControl Atomikos configuration
rscontrol.jta.log=${DIST}/RSControl/log
rscontrol.jta.timeout=600000
rscontrol.jta.max_actives=500
- RSControl hibernate configuration
rscontrol.hibernate.dbtype=${hibernate.dbtype}
rscontrol.hibernate.hibernate.default_schema=${hibernate.default_schema}
- RSControl archive settings
rscontrol.archive.active=false
rscontrol.archive.schedule=0 0 2 * * ?
rscontrol.archive.expiry=86400
rscontrol.archive.cleanup=604800
rscontrol.archive.sleeptime=300
rscontrol.archive.instantinsert=false
#if true, inserts into archive_execute_request, archive_execute_result and archive_execute_result_lob
rscontrol.archive.archiveexecutedata=false
#number of records to be inserted/deleted as a block.
rscontrol.archive.blocksize = 50000
#sleep time in seconds between a block operation.
rscontrol.archive.blocksleeptime = 120
#currently for resolve_process_request and worksheet tables.
rscontrol.archive.smalltableblocksize = 20000
rscontrol.archive.smalltableblocksleeptime = 10
- RSControl Social configuration
rscontrol.social.active=true
rscontrol.social.archive=0 0 3 * * ?
rscontrol.social.dailyemail=0 0 4 * * ?
- User that owns RSControl installation
rscontrol.run.R_USER=${resolve.user}
- Additional java_option when rscontrol is run
- RSControl Elasticsearch configuration
rscontrol.search.active=true
rscontrol.search.serverlist=${rssearch.serverlist}
rscontrol.search.shards=${rssearch.shards}
rscontrol.search.replicas=${rssearch.replicas}
rscontrol.search.indexthreads=${rssearch.indexthreads}
rscontrol.search.indextimout=${rssearch.indextimout}
rscontrol.search.indexretries=${rssearch.indexretries}
rscontrol.search.serverport=${rssearch.yml.transport.tcp.port}
rscontrol.search.cluster=${rssearch.yml.cluster.name}
rscontrol.search.clienttype=${rssearch.clienttype}
rscontrol.search.http=${rssearch.yml.http.enabled}
rscontrol.search.httpport=${rssearch.yml.http.port}
rscontrol.search.analytics=false
rscontrol.search.embedded=false
rscontrol.search.datadir=${DIST}/tmp/es
#TTL is in seconds, default is 3 months (60*60*24*30*3)
#ES removes system and rss posts based on this
rscontrol.search.ttl=7776000
- RSControl selfcheck configuration
rscontrol.selfcheck.db.interval=300
rscontrol.selfcheck.db.active=false
rscontrol.selfcheck.db.timeout=5
rscontrol.selfcheck.es.active=false
rscontrol.selfcheck.es.interval=300
rscontrol.selfcheck.es.retry=5
rscontrol.selfcheck.es.retrydelay=10
rscontrol.selfcheck.ping.active=false
rscontrol.selfcheck.ping.threshold=5
rscontrol.selfcheck.ping.interval=300
rscontrol.selfcheck.threadpool.interval=300
rscontrol.selfcheck.rbexec.active=false
rscontrol.selfcheck.rbexec.interval=300
rscontrol.selfcheck.rbexec.runbook=Mesh.Test100
RSControl General Properties
Property Name | Description | Default Value |
---|
rscontrol.general.home | Location of the RSControl folder. | ${DIST} |
rscontrol.general.clustername | Name of the Actions Pro cluster. | ${CLUSTERNAME} |
rscontrol.general.configfileversion | Version of the config file. | 1.0 |
rscontrol.general.configrevisions | Number of backups of the config file to store. | 2 |
rscontrol.general.saveconfigonstart | Set to 'true' to save the rscontrol config.xml on start. | true |
rscontrol.general.saveconfigonexit | Set to 'true' to save the rscontrol config.xml on exit. | true |
rscontrol.general.savecrononexit | Save the cron.ini file on exit. | false |
rscontrol.general.cronoffset | Period of time by which to offset cron jobs. | 0 |
rscontrol.general.waitingtaskthreshold | Maximum amount of tasks that can wait on the queue. | 15 |
rscontrol.general.maxthread | Maximum number of threads RSControl can spin up. | 200 |
rscontrol.general.maxsystemthread | Maximum number of system threads that can be spun up. | 100 |
rscontrol.general.snmptraphost | Host to send snmp traps over. | |
rscontrol.general.snmptrapport | Port to send snmp traps over. | 162 |
rscontrol.general.timezone | Timezone of the RSControl component. | |
rscontrol.general.threadkeepalive | If the number of threads is greater than the core, this is the maximum time that excess idle threads will wait for new tasks before terminating. | 30 |
rscontrol.general.perfdebug | Set to 'true' to enable performance debugging. | false |
rscontrol.general.executorbusyratio | Amount of busy threads to non busy threads for the executor to be considered busy. | 0.9 |
rscontrol.general.sysexecutorbusyratio | Amount of busy threads to non busy threads for the sysexecutor to be considered busy. | 0.9 |
rscontrol.general.startexecutorbusyratio | Amount of busy threads to non busy threads for the startexecutor to be considered busy. | 0.9 |
rscontrol.general.dbpoolbusyratio | Amount of in use connections to non in use connections for the database connection to be considered busy. | 0.9 |
rscontrol.general.maxrunbooklimit | Maximum number of running runbooks allowed. | 400 |
rscontrol.general.minrunbooklimit | Minimum number of running runbooks allowed. | 1 |
rscontrol.general.userunbookcount | Set to 'true' to use the active runbook count. | false |
rscontrol.general.mcpmode | Set the mcp mode | ${MCPMODE} |
RSControl Log4j Properties
Property Name | Description | Default Value |
---|
rscontrol.log4j.Loggers.Root.level | Defines common log level. | WARN |
rscontrol.log4j.Loggers.Root.appender-ref.ref | | RSCONTROL |
rscontrol.log4j.Loggers.Logger.com.resolve.rscontrol.level | | ${rscontrol.log4j.loglevel} |
rscontrol.log4j.Loggers.Logger.com.mchange.v2.level | | INFO |
rscontrol.log4j.Loggers.Logger.org.quartz.level | | ERROR |
rscontrol.log4j.Loggers.Logger.syslog.level | | ERROR |
rscontrol.log4j.Loggers.Logger.syslog.additivity | | false |
rscontrol.log4j.Appenders.RollingFile.RSCONTROL.fileName | | rscontrol/log/rscontrol.log |
rscontrol.log4j.Appenders.RollingFile.RSCONTROL.filePattern | | rscontrol/log/$\\${date:yyyy-MM}/rscontrol-%d{MM-dd-yyyy}-%i.log.zip |
rscontrol.log4j.Appenders.RollingFile.RSCONTROL.PatternLayout.pattern | | %d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n |
rscontrol.log4j.Appenders.RollingFile.RSCONTROL.SizeBasedTriggeringPolicy.size | | 32MB |
rscontrol.log4j.Appenders.RollingFile.RSCONTROL.DefaultRolloverStrategy.max | | 30 |
rscontrol.log4j.logger.atomikos | This log level should not be changed unless advised by support. | ERROR |
rscontrol.log4j.logger.com.atomikos | This log level should not be changed unless advised by support | WARN, Atomikos |
rscontrol.log4j.appender.Atomikos | File appender used. | org.apache.log4j.RollingFileAppender |
rscontrol.log4j.appender.Atomikos.File | The log file used by atomikos | rscontrol/log/tm.out |
rscontrol.log4j.appender.Atomikos.MaxFileSize | max file size of the atomikos file | 100KB |
rscontrol.log4j.appender.Atomikos.Append | Set to 'true' to have log4j append to the rootlogger as well as its own log file. | false |
rscontrol.log4j.appender.Atomikos.layoutclass used to configure how log4j prints to the file | org.apache.log4j.PatternLayout | |
rscontrol.log4j.appender.Atomikos.layout.ConversionPattern | pattern that the log are printed on the log file to, e.g. <path> <time> <category> - <message><line separator> | %p %t %c - %m%n |
RSControl ESB Properties
Property Name | Description | Default Value |
---|
rscontrol.esb.product | Name of the messaging application used, do not change unless advised by support. | ${rsmq.product} |
rscontrol.esb.brokeraddr | Address used by the rabbitmq broker in the host:port format. | ${RSMQ_EXTERNAL_PRIMARY_HOST}:${RSMQ_EXTERNAL_PRIMARY_PORT} |
rscontrol.esb.username | Username for the rsmq client. | ${rsmq.username} |
rscontrol.esb.password | Password for the given rsmq username. | ${rsmq.password} |
rscontrol.esb.domain | deprecated* | domain1 |
rscontrol.esb.brokername | deprecated* | router1 |
rscontrol.esb.mgmtaddr | deprecated* | |
rscontrol.esb.brokeraddr2 | Address of the rabbitmq backup broker in the host:port format. | ${RSMQ_EXTERNAL_BACKUP_HOST}:${RSMQ_EXTERNAL_BACKUP_PORT} |
rscontrol.esb.createqueueretry | Time period before retrying to create a queue. | 30 |
rscontrol.esb.createqueuewait | Time period to wait before creating a queue. | 10 |
rscontrol.esb.keepalive | After how long time to send a keep alive message. | 0 |
rscontrol.esb.maxfailed | Maximum number of failed messages allowed. | 10 |
rscontrol.esb.cachesize | Max number of messages cached. | 500 |
rscontrol.esb.flowcontrolstartqueuesize | Number of messages allowed before flow control activates. | 400 |
rscontrol.esb.maxmessages | Maximum number of messages store, a value of -1 means unlimited messages. | 1 |
rscontrol.esb.messagettl | Time period in which a message has to live, in milliseconds. | 600000 |
rscontrol.esb.sslprotocol | Name of the encryption protocol used by rabbitmq, should be at least TLSv1.1. | TLSv1.2 |
rscontrol.esb.vhost | | ${rsmq.vhost} |
RSControl SQL Properties
Property Name | Description | Default Value |
---|
rscontrol.sql.dbtype | Type of database used by MySQL. | ${DB_TYPE} |
rscontrol.sql.dbname | Name of the database used. | ${DB_NAME} |
rscontrol.sql.host | Address of the database. | ${DB_HOST} |
rscontrol.sql.username | Username for a user with access to the database. | ${DB_USERNAME} |
rscontrol.sql.password | Password for the given username. | ${DB_PASSWORD} |
rscontrol.sql.url | The url of the database including the driver, the host, the port, and the database name. | ${DB_URL} |
rscontrol.sql.maxpoolsize | Maximum size of the connection pool. | 100 |
rscontrol.sql.minpoolsize | Minimum size of the connection pool. | ${rscontrol.sql.maxpoolsize} |
rscontrol.sql.maxidletime | Maximum period of time for a connection to remain idle. | 60 |
rscontrol.sql.perfdebug | Set to 'true 'to use perfomance schema to debug | false |
rscontrol.sql.usexadatasource | Set to 'true' to use xdatasource instead of datasource. | false |
RSControl ID Properties
Property Name | Description | Default Value |
---|
rscontrol.id.group | Name of the Actions Pro cluster. | ${CLUSTERNAME} |
rscontrol.id.description | Description of the component. | RSCONTROL |
rscontrol.id.location | Location and address of Actions Pro. | ${LOCALHOST} |
rscontrol.gse.path | Path to the groovy service scripts. | ${DIST}/rscontrol/service |
rscontrol.registration.expiration | Period of time before the registration is set to inactive. | 10080 |
rscontrol.registration.discard | Period of time to discard an inactive registration. | 43200 |
rscontrol.registration.election | Period of time inbetween elections of a master node. | 30 |
rscontrol.registration.interval | Set the interval between each heartbeat in minutes. | 5 |
rscontrol.registration.logheartbeat | Set to 'true' to log each heartbeat. | true |
RSControl Ehcache Properties
Property Name | Description | Default Value |
---|
rscontrol.ehcache.defaultCache.maxElementsInMemory | Set the max amount of mappings that can be stored in cache. | 10000 |
rscontrol.ehcache.defaultCache.eternal | Set to 'true' to forbid to mappings in cache to expire. | true |
rscontrol.ehcache.defaultCache.maxElementsOnDisk | The maximum object to be held in the disk store. | 10000000 |
rscontrol.ehcache.defaultCache.diskExpiryThreadIntervalSeconds | Interval in seconds between runs of the disk expiry thread. | 120 |
RSControl Jta Properties
Property Name | Description | Default Value |
---|
rscontrol.jta.log | Path to the log folder. | ${DIST}/rscontrol/log |
rscontrol.jta.timeout | Period of time needed by a transaction to timeout. | 600000 |
rscontrol.jta.max_actives | Maximum amount of transactions that can be active simultaneously. | 500 |
RSControl Hibernate Properties
Property Name | Description | Default Value |
---|
rscontrol.hibernate.dbtype | Type of database used. | ${hibernate.dbtype} |
rscontrol.hibernate.hibernate.default_schema | Schema of the database used. | ${hibernate.default_schema} |
RSControl Archive Properties
Property Name | Description | Default Value |
---|
rscontrol.archive.active | Set to 'true' to active archiving. | false |
rscontrol.archive.schedule | Time at which Actions Pro starts the archiving process. | 0 0 2 * * ? |
rscontrol.archive.expiry | How long until a worksheet expires, in seconds. | 86400 |
rscontrol.archive.cleanup | Time until the cleanup process begins. | 604800 |
rscontrol.archive.sleeptime | Time for the archive process to sleeps between long SQL execution. | 300 |
rscontrol.archive.instantinsert | If 'true', system will instantly insert data into archive table. | false |
rscontrol.archive.archiveexecutedata | If 'true', inserts into archive_execute_request, archive_execute_result and archive_execute_result_lob | false |
rscontrol.archive.blocksize | Number of records to be inserted/deleted as a block. | 20000 |
rscontrol.archive.blocksleeptime | Sleep time in seconds between block operations. | 600 |
rscontrol.archive.smalltableblocksize | Currently for resolve_process_request and worksheet tables. | 10000 |
rscontrol.archive.smalltableblocksleeptime | Sleep time in seconds between block delete for small table. | 60 |
RSControl Social Properties
Property Name | Description | Default Value |
---|
rscontrol.social.active | Set to 'true' to use social. | true |
rscontrol.social.active | At what time an archive process runs everyday, default is 3am. | 0 0 3 * * ? |
rscontrol.social.dailyemail | At what time a daily email is sent out, default is 4am. | 0 0 4 * * ? |
RSControl Run Properties
Property Name | Description | Default Value |
---|
rscontrol.run.R_USER | Name of the Actions Pro Linux user. | ${resolve.user} |
rscontrol.run.java_opts | Any extra java options to add to the component start up. | |
rscontrol.run.terminatetimeout | Time period for rscontrol run to timeout. | 600 |
These properties should mirror the rs search properties.
RSControl Search Properties
Property Name | Description | Default Value |
---|
rscontrol.search.active | deprecated* | true |
rscontrol.search.serverlist | List of the nodes used by RSSearch. | ${rssearch.serverlist} |
rscontrol.search.shards | Number of shards per index. | ${rssearch.shards} |
rscontrol.search.replicas | Number of replicas per shard. | ${rssearch.replicas} |
rscontrol.search.indexthreads | deprecated* | ${rssearch.indexthreads} |
rscontrol.search.indextimout | The time need by a request of an index to timeout, in seconds. | ${rssearch.indextimout} |
rscontrol.search.indexretries | How many times a read or write to an index should be attempted. | ${rssearch.indexretries} |
rscontrol.search.serverport | Port RSSearch listens on for http requests. | ${rssearch.yml.transport.tcp.port} |
rscontrol.search.cluster | Name used to discover and auto-join nodes. | ${rssearch.yml.cluster.name} |
rscontrol.search.clienttype | Set whether clients should be node or transport. | ${rssearch.clienttype} |
rscontrol.search.http | Set to 'true' to enable http. | ${rssearch.yml.http.enabled} |
rscontrol.search.httpport | Port ES binds for http use. | ${rssearch.yml.http.port} |
rscontrol.search.ttl | For how long does Elasticsearch stores files. | ${search.ttl} |
rscontrol.sync | Set to 'true' to sync RSSearch nodes. | false |
rscontrol.synccluster | Name of the remote cluster used for discovery. | ${RSSEARCH_SYNC_CLUSTERNAME} |
rscontrol.syncserverlist | List of server nodes to sync. | ${RSSEARCH_SYNC_NODES} |
rscontrol.syncserverport | Port to sync RSSearch nodes over. | 9300 |
RSControl Self Properties
Property Name | Description | Default Value |
---|
rscontrol.selfcheck.db.interval | Interval between selfchecks. | 300 |
rscontrol.selfcheck.db.active | Set to 'check' for the status of the database. | false |
rscontrol.selfcheck.db.timeout | Period of time in seconds needed by a selfcheck of the database to timeout. | 5 |
rscontrol.selfcheck.es.active | Set to 'true' to activate selfchecks for Elasticsearch. | false |
rscontrol.selfcheck.es.interval | Intervals between selfchecks to Elasticsearch. | 300 |
rscontrol.selfcheck.es.retry | How many times to retry sending a selfcheck message to Elasticsearch. | 5 |
rscontrol.selfcheck.es.retrydelay | Period of time to wait in between retries. | 10 |
rscontrol.selfcheck.ping.active | Set to 'true' to ping RSRemote and check its status. | false |
rscontrol.selfcheck.ping.threshold | Period of time needed by a ping to timeout. | 5 |
rscontrol.selfcheck.ping.interval | Interval between pings to RSRemote. | 300 |
rscontrol.selfcheck.threadpool.active | Set to 'true' to check if the RSCONTROL threadpool is at its max. | false |
rscontrol.selfcheck.threadpool.interval | Interval in between checks for the threadpool health. | 300 |
rscontrol.selfcheck.threadpool.time | Period of time to wait before rechecking threadpool count after a threadpool count exceeds the maximum allowed number. | 10 |
rscontrol.selfcheck.rbexec.active | Set to 'true' to selfcheck the health of the runbook executor. | false |
rscontrol.selfcheck.rbexec.interval | Period of time in between the checks to the runbook executor. | 300 |
rscontrol.selfcheck.rbexec.runbook | Runbook used to test the status of the runbook executor. | Mesh.Test100 |
RSView Settings
All RSView Settings
The following lists shows the logical groups of RSView properties and their default values.
- RSView config.xml GENERAL information
rsview.general.primary=${PRIMARY}
rsview.general.home=${DIST}
rsview.general.clustername=${CLUSTERNAME}
rsview.general.heartbeat=20
rsview.general.failover=60
rsview.general.configrevisions=1
rsview.general.threadkeepalive=30
rsview.general.perfdebug=false
rsview.general.mcpmode=${MCPMODE}
rsview.general.saveusercredentials=false
rsview.general.environment=${ENVIRONMENT}
rsview.general.gatewayhealthcheckintervalinminutes=10
rsview.general.scheduledpool=100
rsview.general.taskExecutor.executorAlarmThreadLimit=1000
rsview.general.cachecontrolmaxage=31536000
#comma separated list of addresses
#example:
#rsview.general.reportingInstances=http://localhost:19098,http://10.50.0.109:9999
rsview.general.reportingInstances=${RSVIEW_RSREPORTING_INSTANCES}
rsview.general.sslEnabled=${RSVIEW_SSL_ENABLED}
rsview.general.sslVerify=${RSVIEW_SSL_VERIFY}
rsview.general.trustStore=${RSVIEW_TRUSTSTORE_PATH}
rsview.general.trustStorePassword=${RSVIEW_TRUSTSTORE_PASSWORD}
rsview.general.dcsAuthenticationInstance=${RSREMOTE_RSDATALOADER_URL}/login
rsview.general.dcsAuthenticationUsername=rsview
rsview.general.dcsAuthenticationPassword=Resolve1
rsview.general.isDcsEnabled=${resolve.dcs}
- RSView Log4j configuration
rsview.log4j.Loggers.Root.level=WARN
rsview.log4j.Loggers.Root.appender-ref.ref=TOMCAT
rsview.log4j.Loggers.Logger.com.resolve.rsview.level=${rsview.log4j.loglevel}
rsview.log4j.Loggers.Logger.com.resolve.rsview.additivity=false
rsview.log4j.Loggers.Logger.com.resolve.rsview.appender-ref.ref=RSVIEW
rsview.log4j.Loggers.Logger.syslog.level=INFO
rsview.log4j.Loggers.Logger.syslog.additivity=false
rsview.log4j.Loggers.Logger.org.apache.struts.util.RequestUtils.level=INFO
rsview.log4j.Loggers.Logger.org.apache.struts.util.RequestUtils.appender-ref.ref=RSVIEW
rsview.log4j.Loggers.Logger.net.sf.ehcache.level=INFO
rsview.log4j.Loggers.Logger.net.sf.ehcache.appender-ref.ref=EHCACHE
rsview.log4j.Loggers.Logger.com.resolve.auth.level=INFO
rsview.log4j.Loggers.Logger.com.resolve.auth.additivity=false
rsview.log4j.Loggers.Logger.com.resolve.auth.appender-ref.ref=AUTH
rsview.log4j.Loggers.Logger.com.resolve.services.schedules.SystemWorksheetRemover.level=INFO
rsview.log4j.Loggers.Logger.com.resolve.services.schedules.SystemWorksheetRemover.additivity=false
rsview.log4j.Loggers.Logger.com.resolve.services.schedules.SystemWorksheetRemover.appender-ref.ref=SYSTEMWORKSHEETS
rsview.log4j.Loggers.Logger.org.hibernate.cache.ehcache.AbstractEhcacheRegionFactory.level=INFO
rsview.log4j.Appenders.RollingFile.EHCACHE.fileName=${DIST}/tomcat/logs/ehcache.log
rsview.log4j.Appenders.RollingFile.EHCACHE.filePattern=${DIST}/tomcat/logs/$\${date:yyyy-MM}/ehcache-%d{MM-dd-yyyy}-%i.log.zip
rsview.log4j.Appenders.RollingFile.EHCACHE.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
rsview.log4j.Appenders.RollingFile.EHCACHE.SizeBasedTriggeringPolicy.size=32MB
rsview.log4j.Appenders.RollingFile.EHCACHE.DefaultRolloverStrategy.max=6
rsview.log4j.Appenders.RollingFile.RSVIEW.fileName=${DIST}/tomcat/logs/rsview.log
rsview.log4j.Appenders.RollingFile.RSVIEW.filePattern=${DIST}/tomcat/logs/$\${date:yyyy-MM}/rsview-%d{MM-dd-yyyy}-%i.log.zip
rsview.log4j.Appenders.RollingFile.RSVIEW.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
rsview.log4j.Appenders.RollingFile.RSVIEW.SizeBasedTriggeringPolicy.size=32MB
rsview.log4j.Appenders.RollingFile.RSVIEW.DefaultRolloverStrategy.max=6
rsview.log4j.Appenders.RollingFile.TOMCAT.fileName=${DIST}/tomcat/logs/catalina.out
rsview.log4j.Appenders.RollingFile.TOMCAT.filePattern=${DIST}/tomcat/logs/$\${date:yyyy-MM}/catalina-%d{MM-dd-yyyy}-%i.log.zip
rsview.log4j.Appenders.RollingFile.TOMCAT.PatternLayout.pattern=%p %t %c - %m%n
rsview.log4j.Appenders.RollingFile.TOMCAT.SizeBasedTriggeringPolicy.size=32MB
rsview.log4j.Appenders.RollingFile.TOMCAT.DefaultRolloverStrategy.max=6
rsview.log4j.Appenders.RollingFile.AUTH.fileName=${DIST}/tomcat/logs/auth.log
rsview.log4j.Appenders.RollingFile.AUTH.filePattern=${DIST}/tomcat/logs/$\${date:yyyy-MM}/auth-%d{MM-dd-yyyy}-%i.log.zip
rsview.log4j.Appenders.RollingFile.AUTH.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
rsview.log4j.Appenders.RollingFile.AUTH.Policies.TimeBasedTriggeringPolicy.interval=1
rsview.log4j.Appenders.RollingFile.AUTH.Policies.TimeBasedTriggeringPolicy.modulate=true
rsview.log4j.Appenders.RollingFile.SYSTEMWORKSHEETS.fileName=${DIST}/tomcat/logs/RSSystemWorksheets.log
rsview.log4j.Appenders.RollingFile.SYSTEMWORKSHEETS.filePattern=${DIST}/tomcat/logs/$\${date:yyyy-MM}/RSSystemWorksheets-%d{MM-dd-yyyy}-%i.log.zip
rsview.log4j.Appenders.RollingFile.SYSTEMWORKSHEETS.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
rsview.log4j.Appenders.RollingFile.SYSTEMWORKSHEETS.SizeBasedTriggeringPolicy.size=32MB
rsview.log4j.Appenders.RollingFile.SYSTEMWORKSHEETS.DefaultRolloverStrategy.max=100
- RSView config.xml ESB information
rsview.esb.product=${rsmq.product}
rsview.esb.brokeraddr=${RSMQ_EXTERNAL_PRIMARY_HOST}:${RSMQ_EXTERNAL_PRIMARY_PORT}
rsview.esb.username=${rsmq.username}
rsview.esb.password=${rsmq.password}
rsview.esb.domain=domain1
rsview.esb.brokername=router1
rsview.esb.mgmtaddr=
rsview.esb.brokeraddr2=${RSMQ_EXTERNAL_BACKUP_HOST}:${RSMQ_EXTERNAL_BACKUP_PORT}
rsview.esb.createqueueretry=30
rsview.esb.createqueuewait=10
rsview.esb.keepalive=0
rsview.esb.maxfailed=10
rsview.esb.cachesize=500
rsview.esb.flowcontrolstartqueuesize=400
rsview.esb.maxmessages=-1
rsview.esb.messagettl=1200000
rsview.esb.vhost=${rsmq.vhost}
- RSView registration information
rsview.registration.logheartbeat=true
- RSview JDK environment
rsview.env.RSVIEWJDK=${resolve.java_home}
- RSView keyservice configuration
rsview.keyservice.proto=${KEYSERVICE_PROTO}
rsview.keyservice.host=${KEYSERVICE_HOST}
rsview.keyservice.port=${KEYSERVICE_PORT}
rsview.keyservice.username=${KEYSERVICE_USERNAME}
rsview.keyservice.pwd=${KEYSERVICE_PWD}
- RSView config.xml SQL information
rsview.sql.dbtype=${DB_TYPE}
rsview.sql.dbname=${DB_NAME}
rsview.sql.host=${DB_HOST}
rsview.sql.username=${DB_USERNAME}
rsview.sql.password=${DB_PASSWORD}
rsview.sql.url=${DB_URL}
rsview.sql.maxpoolsize=200
rsview.sql.minpoolsize=${rsview.sql.maxpoolsize}
rsview.sql.maxidletime=60
- RSControl config.xml ESB information
rsview.search.active=true
rsview.search.serverlist=${rssearch.serverlist}
rsview.search.shards=${rssearch.shards}
rsview.search.replicas=${rssearch.replicas}
rsview.search.indexthreads=${rssearch.indexthreads}
rsview.search.indextimout=${rssearch.indextimout}
rsview.search.indexretries=${rssearch.indexretries}
rsview.search.serverport=${rssearch.yml.transport.tcp.port}
rsview.search.cluster=${rssearch.yml.cluster.name}
rsview.search.clienttype=${rssearch.clienttype}
rsview.search.http=${rssearch.yml.http.enabled}
rsview.search.httpport=${rssearch.yml.http.port}
rsview.search.analytics=false
rsview.search.embedded=false
rsview.search.datadir=${DIST}/tmp/es
#TTL is in seconds, default is 3 months (60*60*24*30*3)
#ES removes system and rss posts based on this
rsview.search.ttl=7776000
#Set value to specify a full URL enpoint for RSSearch's kibana and big desk app tools.
#If left blank it will be calculated from the rsview.search fields
#The calculated URL will be in the form "http://192.168.0.1:9200".
rsview.search.endpoint=
- RSView registration information
rsview.id.group=default
rsview.id.description=RSVIEW
rsview.id.location=${LOCALHOST}
- Location of RSView Groovy scripts, executable from RSConsole commands
rsview.gse.path=${DIST}/tomcat/webapps/resolve/WEB-INF/service
- Location of RSView logs
rsview.log=${DIST}/tomcat/logs
- RSView ehcache configuration
rsview.ehcache.defaultCache.maxElementsInMemory=10000
rsview.ehcache.defaultCache.eternal=true
rsview.ehcache.defaultCache.maxElementsOnDisk=10000000
rsview.ehcache.defaultCache.diskExpiryThreadIntervalSeconds=120
- Configuration information for Atomikos
rsview.jta.log=${DIST}/tomcat/logs
rsview.jta.timeout=600000
rsview.jta.max_actives=1500
- Tomcat connection configuration.
For further details refer to Tomcat Settings in Architecture Overview.sview.tomcat.server.port=8005
rsview.tomcat.connector.ajp.port=8009
rsview.tomcat.connector.ajp.redirectport=8443
rsview.tomcat.http=false
rsview.tomcat.connector.http.port=8080
rsview.tomcat.connector.http.redirectport=8443
rsview.tomcat.https=true
rsview.tomcat.connector.https.port=8443
#For Keystore Password Encryption Change protocol to custom class com.resolve.tomcat.connector.ResolveHttp11Protocol
rsview.tomcat.connector.protocol=HTTP/1.1
#keystore file is a relative path to DIST location to ensure location always have write permission
rsview.tomcat.connector.https.keystoreFile=/home/resolve/.keystore
rsview.tomcat.connector.https.keystorePass=resolve
rsview.tomcat.connector.https.sslEnabledProtocols=TLSv1.2
rsview.tomcat.connector.https.ciphers=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_RC4_128_SHA,TLS_RSA_WITH_AES_128_CBC_SHA256,
TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_256_CBC_SHA256,TLS_RSA_WITH_AES_256_CBC_SHA,SSL_RSA_WITH_RC4_128_SHA,
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
rsview.tomcat.connector.maxthreads=500
rsview.tomcat.connector.compression=on
rsview.tomcat.connector.compressionMinSize=2048
rsview.tomcat.connector.noCompressionUserAgents=gozilla, traviata
rsview.tomcat.connector.compressableMimeType=text/html,text/xml,text/javascript,text/css,text/plain,text/json,application/javascript,application/json,application/xml
- RSView Ajax2/Web Service configuration
rsview.axis2.http=${rsview.tomcat.http}
rsview.axis2.connector.http.port=${rsview.tomcat.connector.http.port}
rsview.axis2.https=${rsview.tomcat.https}
rsview.axis2.connector.https.port=${rsview.tomcat.connector.https.port}
- RSView set http to https forwarding on or off
rsview.web.httpsForward=false
- RSView hibernate configuration
rsview.hibernate.dbtype=${hibernate.dbtype}
rsview.hibernate.hibernate.default_schema=${hibernate.default_schema}
- RSView reporting dashboard configuration
rsview.dashboard.dbtype=${DB_TYPE}
rsview.dashboard.dbname=${DB_NAME}
rsview.dashboard.defaultDB=${DB_SCHEMA}
rsview.dashboard.host=${DB_HOST}
rsview.dashboard.user=${DB_USERNAME}
rsview.dashboard.password=${DB_PASSWORD}
rsview.dashboard.url=${DB_URL}
- RSView selfcheck configuration
rsview.selfcheck.es.active=false
rsview.selfcheck.es.retrydelay=10
rsview.selfcheck.es.interval=300
rsview.selfcheck.es.retry=5
rsview.selfcheck.ping.active=false
rsview.selfcheck.ping.threshold=5
rsview.selfcheck.ping.interval=300
rsview.selfcheck.db.active=false
rsview.selfcheck.db.interval=300
rsview.selfcheck.db.timeout=5
rsview.selfcheck.ldapadsc.active=false
rsview.selfcheck.ldapadsc.interval=300
rsview.selfcheck.http.active=false
rsview.selfcheck.http.interval=300
- User that owns RSView installation
rsview.run.R_USER=${resolve.user}
- Additional java_option when RSView is run
- The only URL which does not require CSRF protection is Login URL.
Add additional values by copying this property and incrementing the .N count Values must be in the form of <Key>=<URL>
.rsview.csrfguard.unprotected.1=
RSVeiw Authentication
Actions Pro has two different methods to authenticate against Active Directory (AD) and Lightweight Directory Access Protocol (LDAP). For Active Directory, a user can further enable the Single Sign-On, allowing users to be automatically signed into Actions Pro using their Desktop session.
RSVeiw LDAP Authentication
Property Name | Description | Default Value |
---|
rsview.auth.ldap.active | Set to 'true' to activate LDAP authentication for Actions Pro. | false |
rsview.auth.ldap.ipaddress | The IP address for lDAP authentication. | |
rsview.auth.ldap.port | The port used by Actions Pro for LDAP authentication. | 389 |
rsview.auth.ldap.ssl | Set to 'true' to use ssl with LDAP. | false |
rsview.auth.ldap.sync | Set to 'true' to sync LDAP properties file with LDAP server. | true |
rsview.auth.ldap.fallback | Set to 'true' to fallback to result authentication if LDAP auth fails. | true |
rsview.auth.ldap.basedn.dn.1 | The base point for the server to search for a user. | o=resolve,c=us |
rsview.auth.ldap.default_domain | The default domain to add to the user, if they do not specify a domain. | |
rsview.auth.ldap.mode | The way Actions Pro authenticates user: BIND, binds using user account: BIND_UID binds using user account but with specified user id:COMPARE, binds using bind_dn account and compares passwords locally:COMPARE_LDAP binds using bind_dn account and compares through ldap compare call. | BIND |
rsview.auth.ldap.uid_attribute | The u_id used to bind with. | u_id |
rsview.auth.ldap.bind_dn | The account to bind with, if mode is set to COMPARE or COMPARE_LDAP | o=resolve,c=us |
rsview.auth.ldap.bind_password | The password to bind with, if mode is set to COMPARE or COMPARE_LDAP | resolve |
rsview.auth.ldap.password_attribute | The field where the password is stored when mode is set to COMPARE or COMPARE_LDAP | userPassword |
rsview.auth.ldap.crypt_type | Encryption method used to encrypt password when comparing locally. | CLEAR |
rsview.auth.ldap.crypt_prefix | Prefix to prepend to bind_password. | DEFAULT |
rsview.auth.ldap.version | LDAP version that is in use. | 3 |
rsview.auth.ldap.grouprequired | If 'true' then the user logging into Actions Pro should have at least 1 LDAP group assigned. | false |
Authenticate via LDAP/Active Directory
Actions Pro can have more than one RSRemote. For the authentication to more than one LDAP/Active Directory follow these steps:
- Set the "unearth" to true for user authentication uses.
- Review LDAP configuration and Active Directory configuration under the User Administration main menu.
- Set the active flag to true to enable the LDAP/Active Directory for RSRemote.
rsremote.receive.ldap.active=true
rsremote.receive.ldap.queue=LDAP
#if userauth=true this gateway may be used for Actions Pro user authentication
rsremote.receive.ldap.userauth=true
#if this flag is true, than for user loging in Actions Pro, should have at least 1 LDAP group assigned
rsremote.receive.ldap.grouprequired=true
rsremote.receive.ad.active=true
rsremote.receive.ad.queue=AD
#if userauth=true this gateway may be used for Actions Pro user authentication
rsremote.receive.ad.userauth=true
#if this flag is true, than for user loging in Actions Pro, should have at least 1 AD group assigned
rsremote.receive.ad.grouprequired=true
RSVeiw Active Directory Authentication
Property Name | Description | Default value |
---|
rsview.auth.active_directory.active | Set to 'true' to activate Active Directory authentication for Actions Pro. | false |
rsview.auth.active_directory.ipaddress= | The IP address for AD authentication. | |
rsview.auth.active_directory.port | The port used by Actions Pro for AD authentication. | 389 |
rsview.auth.active_directory.ssl | Set to 'true' to use ssl with AD | false |
rsview.auth.active_directory.sync | Set to 'true' to sync AD properties file with AD server. | true |
rsview.auth.active_directory.fallback | Set to 'true' to fall back to result authentication if AD auth fails. | true |
rsview.auth.active_directory.default_domain | The default domain to add to the user, if they do not specify a domain. | |
rsview.auth.active_directory.basedn.dn.1=dc=resolve,c=com | | |
rsview.auth.active_directory.mode | The way Actions Pro authenticates user: BIND, binds using user account: BIND_UID binds using user account but with specified user id: COMPARE, binds using bind_dn account and compares passwords locally: COMPARE_AD binds using bind_dn account and compares through AD compare call. | BIND |
rsview.auth.active_directory.uid_attribute | The u_id used to bind with. | sAMAccountName |
rsview.auth.active_directory.bind_dn | The base point for the server to search for a user. | |
rsview.auth.active_directory.bind_password | Prefix to prepend to bind_password. | |
rsview.auth.active_directory.version | Active Directory version that is in use. | 3 |
#if this flag is true, than for user loging in Actions Pro, should have atleast 1 AD group assignedrsview.auth.active_directory.grouprequired | If 'true' then the user logging into Actions Pro should have at least 1 LDAP group assigned. | false |
RSView General
Property Name | Description | Default Value |
---|
rsview.general.primary | If 'true' then this RSView instace is the primary RSView. | ${PRIMARY} |
rsview.general.home | Parent directory of the tomcat directory. | ${DIST} |
rsview.general.clustername | Name of the Actions Pro cluster. | ${CLUSTERNAME} |
rsview.general.heartbeat | deprecated* | 20 |
rsview.general.failover | deprecated* | 60 |
rsview.general.maxthread | Maximum amount of allowed threads. | 200 |
rsview.general.maxsystemthread | Maximum amount of allowed concurrent active system threads allowed. | 100 |
rsview.general.configrevisions | Number of backup config.xml's to keep. | 1 |
rsview.general.threadkeepalive | If the number of threads is greater than the core, this is the maximum time that excess idle threads will wait for new tasks before terminating. | 30 |
rsview.general.perfdebug | Set to 'true' to enable performance debugging. | false |
rsview.general.mcpmode | The mcp mode. | ${MCPMODE} |
rsview.general.saveusercredentials | Set to 'true' to save user credentials in the session info. | false |
rsview.csrfguard.unprotected.1 | The only URL which does not require CSRF protection is Login URL.Add additional values by copy ting this property and incrementing the .N countValues must be in the form of <Key>=<URL> | |
RSView Log4j
Property Namе | Description | Default Value |
---|
rsview.log4j.Loggers.Root.level | | WARN |
rsview.log4j.Loggers.Root.appender-ref.ref | | TOMCAT |
rsview.log4j.Loggers.Logger.com.resolve.rsview.level | | ${rsview.log4j.loglevel} |
rsview.log4j.Loggers.Logger.com.resolve.rsview.additivity | | false |
rsview.log4j.Loggers.Logger.com.resolve.rsview.appender-ref.ref | | RSVIEW |
rsview.log4j.Loggers.Logger.syslog.level | | INFO |
rsview.log4j.Loggers.Logger.syslog.additivity | | false |
rsview.log4j.Loggers.Logger.org.apache.struts.util.RequestUtils.level | | INFO |
rsview.log4j.Loggers.Logger.org.apache.struts.util.RequestUtils.appender-ref.ref | | RSVIEW |
rsview.log4j.Loggers.Logger.net.sf.ehcache.level | | INFO |
rsview.log4j.Loggers.Logger.net.sf.ehcache.appender-ref.ref | | ENCACHE |
rsview.log4j.Loggers.Logger.com.resolve.auth.level | | INFO |
rsview.log4j.Loggers.Logger.com.resolve.auth.additivity | | false |
rsview.log4j.Loggers.Logger.com.resolve.auth.appender-ref.ref | | AUTH |
rsview.log4j.Loggers.Logger.com.resolve.services.schedules.SystemWorksheetRemover.level | | INFO |
rsview.log4j.Loggers.Logger.com.resolve.services.schedules.SystemWorksheetRemover.additivity | | false |
rsview.log4j.Loggers.Logger.com.resolve.services.schedules.SystemWorksheetRemover.appender-ref.ref | | SYSTEMWORKSHEETS |
rsview.log4j.Loggers.Logger.org.hibernate.cache.ehcache.AbstractEhcacheRegionFactory.level | | INFO |
rsview.log4j.Appenders.RollingFile.EHCACHE.fileName | | ${DIST}/tomcat/logs/ehcache.log |
rsview.log4j.Appenders.RollingFile.EHCACHE.filePattern | | ${DIST}/tomcat/logs/$\\${date:yyyy-MM}/ehcache-%d{MM-dd-yyyy}-%i.log.zip |
rsview.log4j.Appenders.RollingFile.EHCACHE.PatternLayout.pattern | | %d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n |
rsview.log4j.Appenders.RollingFile.EHCACHE.SizeBasedTriggeringPolicy.size | | 32MB |
rsview.log4j.Appenders.RollingFile.EHCACHE.DefaultRolloverStrategy.max | | 6 |
rsview.log4j.Appenders.RollingFile.RSVIEW.fileName | | ${DIST}/tomcat/logs/rsview.log |
rsview.log4j.Appenders.RollingFile.RSVIEW.filePattern | | {DIST}/tomcat/logs/$\\${date:yyyy-MM}/rsview-%d{MM-dd-yyyy}-%i.log.zip |
rsview.log4j.Appenders.RollingFile.RSVIEW.PatternLayout.pattern | | %d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n |
rsview.log4j.Appenders.RollingFile.RSVIEW.SizeBasedTriggeringPolicy.size | | 32MB |
rsview.log4j.Appenders.RollingFile.RSVIEW.DefaultRolloverStrategy.max | | 6 |
rsview.log4j.Appenders.RollingFile.TOMCAT.fileName | | ${DIST}/tomcat/logs/Catalina.out |
rsview.log4j.Appenders.RollingFile.TOMCAT.filePattern | | ${DIST}/tomcat/logs/$\\${date:yyyy-MM}/catalina-%d{MM-dd-yyyy}-%i.log.zip |
rsview.log4j.Appenders.RollingFile.TOMCAT.PatternLayout.pattern | | %p %t %c - %m%n |
rsview.log4j.Appenders.RollingFile.TOMCAT.SizeBasedTriggeringPolicy.size | | 32MB |
rsview.log4j.Appenders.RollingFile.TOMCAT.DefaultRolloverStrategy.max | | 6 |
rsview.log4j.Appenders.RollingFile.AUTH.fileName | | ${DIST}/tomcat/logs/auth.log |
rsview.log4j.Appenders.RollingFile.AUTH.filePattern | | ${DIST}/tomcat/logs/$\\${date:yyyy-MM}/auth-%d{MM-dd-yyyy}-%i.log.zip |
rsview.log4j.Appenders.RollingFile.AUTH.PatternLayout.pattern | | %d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n |
rsview.log4j.Appenders.RollingFile.AUTH.Policies.TimeBasedTriggeringPolicy.interval | | 1 |
rsview.log4j.Appenders.RollingFile.AUTH.Policies.TimeBasedTriggeringPolicy.modulate | | true |
rsview.log4j.Appenders.RollingFile.SYSTEMWORKSHEETS.fileName | | ${DIST}/tomcat/logs/RSSystemWorksheets.log |
rsview.log4j.Appenders.RollingFile.SYSTEMWORKSHEETS.filePattern | | ${DIST}/tomcat/logs/$\\${date:yyyy-MM}/RSSystemWorksheets-%d{MM-dd-yyyy}-%i.log.zip |
rsview.log4j.Appenders.RollingFile.SYSTEMWORKSHEETS.PatternLayout.pattern | | %d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n |
rsview.log4j.Appenders.RollingFile.SYSTEMWORKSHEETS.SizeBasedTriggeringPolicy.size | | 32MB |
rsview.log4j.Appenders.RollingFile.SYSTEMWORKSHEETS.DefaultRolloverStrategy.max | | 100 |
rsview.log4j.logger.com.atomikos | Set the log level for the atomikos package class and the log file to append to. 'loglevel','log file' | WARN, Atomikos |
rsview.log4j.appender.Atomikos | File appender for atomikos to use. | org.apache.log4j.RollingFileAppender |
rsview.log4j.appender.Atomikos.File | File for the atomikos appender to append to. | ${DIST}/tomcat/logs/tm.out |
rsview.log4j.appender.Atomikos.MaxFileSize | Maximum file size for the atomikos log file. | 100KB |
rsview.log4j.appender.Atomikos.Append | Set to 'true' to append to the log file on start up instead of overwriting it. | false |
rsview.log4j.appender.Atomikos.layout | Class to use for log layout. | org.apache.log4j.PatternLayout |
rsview.log4j.appender.Atomikos.layout.ConversionPatter | Pattern for the atomikos logging | %p %t %c - %m%n |
rsview.log4j.appender.RSVIEW.layout | Class used for the layout of the RSVIEW logs. | org.apache.log4j.PatternLayout |
rsview.log4j.appender.RSVIEW.layout.ConversionPattern | Pattern used to log into the RSVIEW log file. | %d %5p [%t] (%F:%L) - %m%n |
rsview.log4j.appender.AUTH.layout | Class used for the layout of the AUTH logs. | org.apache.log4j.PatternLayout |
rsview.log4j.appender.AUTH.layout.ConversionPattern | Pattern used to log into the AUTH log file. | %d %5p [%t] (%F:%L) - %m%n |
rsview.log4j.appender.EHCACHE.layout | Class used for the layout of the EHCACHE logs. | org.apache.log4j.PatternLayout |
rsview.log4j.appender.EHCACHE.layout.ConversionPattern | Pattern used to log into the EHCACHE log file | %d %5p [%t](%F:%L) - %m%n |
rsview.log4j.loggerFactory | Class used for the log4j logger factory. | org.owasp.esapi.reference.Log4JLoggerFactory |
RSView ESB
Property Name | Description | Default Value |
---|
rsview.esb.product | Product used for the esb system. | ${rsmq.product} |
rsview.esb.brokeraddr | Address and port, used by esb for messaging. | ${RSMQ_EXTERNAL_PRIMARY_HOST}:${RSMQ_EXTERNAL_PRIMARY_PORT} |
rsview.esb.username | Username to connect to rsmq. | ${rsmq.username} |
rsview.esb.password | Password used to connect to rsmq. | ${rsmq.password} |
rsview.esb.domain | deprecated* | domain1 |
rsview.esb.brokername | deprecated* | router1 |
rsview.esb.mgmtaddr | deprecated* | |
rsview.esb.brokeraddr2 | Backup address and port used by the esb. | ${RSMQ_EXTERNAL_BACKUP_HOST}:${RSMQ_EXTERNAL_BACKUP_PORT} |
rsview.esb.createqueueretry | Period of time before retrying to create a queue. | 30 |
rsview.esb.createqueuewait | Period of time to wait before creating a queue. | 10 |
rsview.esb.keepalive | After how long to send a keep alive message. | 0 |
rsview.esb.maxfailed | Maximum number of failed messages allowed. | 10 |
rsview.esb.cachesize | Max number of messages cached. | 500 |
rsview.esb.flowcontrolstartqueuesize | Number of messages allowed before flow control activates. | 400 |
rsview.esb.maxmessages | Maximum number of messages store, a value of -1 means unlimited messages. | 1 |
rsview.esb.messagettl | Period of time a message has to live, in milliseconds. | 600000 |
rsview.esb.sslprotocol | Name of the encryption protocol used by rabbitmq, should be at least TLSv1.1 | TLSv1.2 |
rsview.esb.vhost | | ${rsmq.vhost} |
RSView Registration
Property Name | Description | Default Value |
---|
rsview.registration.expiration | Period of time until a registration expires. | 10080 |
rsview.registration.discard | Period of time until registration is discarded. | 43200 |
rsview.registration.interval | Period of time in minutes in between each heartbeat. | 5 |
rsview.registration.logheartbeat | Set to 'true' to log each heartbeat. | true |
RSView SQL
Property Name | Description | Default Value |
---|
rsview.sql.dbtype | Type of database connected to Actions Pro. | ${DB_TYPE} |
rsview.sql.dbname | Name of the database | ${DB_NAME} |
rsview.sql.host | Address of the database | ${DB_HOST} |
rsview.sql.username | Username used to connect to the database. | ${DB_USERNAME} |
rsview.sql.password | Password used to connect to the database. | ${DB_PASSWORD} |
rsview.sql.url | The url used to connect to the database. | ${DB_URL} |
rsview.sql.maxpoolsize | Maximum size of the connection pool. | 100 |
rsview.sql.minpoolsize | Minimum size of the connection pool. | ${rsview.sql.maxpoolsize} |
rsview.sql.maxidletime | Maximum idle time. | 60 |
rsview.sql.perfdebug | Set to 'true' to enable performance debugging. | false |
rsview.sql.usexadatasource | Set to 'true' to use xadatasource. | false |
RSView SQL
Property Name | Description | Default Value |
---|
rsview.search.active | deprecated* | true |
rsview.search.serverlist | List of the nodes used by rssearch | ${rssearch.serverlist} |
rsview.search.shards | Number of shards per index | ${rssearch.shards} |
rsview.search.replicas | Number of replicas per shard | ${rssearch.replicas} |
rsview.search.indexthreads | deprecated* | ${rssearch.indexthreads} |
rsview.search.indextimout | The time needed by a request of an index to timeout, in seconds. | ${rssearch.indextimout} |
rsview.search.indexretries | How many times a read or write to an index should be attempted. | ${rssearch.indexretries} |
rsview.search.serverport | Port rssearch listens on for http requests. | ${rssearch.yml.transport.tcp.port} |
rsview.search.cluster | Name used to discover and auto-join nodes. | ${rssearch.yml.cluster.name} |
rsview.search.clienttype | Set whether clients should be node or transport. | ${rssearch.clienttype} |
rsview.search.http | Set to 'true' to enable http. | ${rssearch.yml.http.enabled} |
rsview.search.httpport | Port ES binds for http use. | ${rssearch.yml.http.port} |
rsview.search.ttl | How long does Elasticsearch stores files. | ${search.ttl} |
rsview.search.sync | Set to 'true' to sync rssearch nodes. | ${rssearch.sync} |
rsview.search.sync cluster | Name of the remote cluster used for discovery. | ${rssearch.sync cluster} |
rsview.search.syncserverlist | List of server nodes to sync. | ${rssearch.syncserverlist} |
rsview.search.syncserverport | Port to sync rssearch nodes over. | ${rssearch.syncserverport} |
rsview.search.synctask | Set to 'true' in one RSView for the intelligent synchronizer task. | false |
rsview.search.synctaskinterval | Interval between sync tasks. | 600 |
rsview.search.log.removeOldLogFiles.enabled | Set to 'true' to clean up old log files. | false |
rsview.search.log.removeOldLogFiles.cronTaskIntervalType | Type of interval cron tasks run. | DAYS |
rsview.search.log.removeOldLogFiles.cronTaskIntervalValue | Period of time in-between removal of old in cronTaskIntervalType. | 30 |
rsview.search.log.removeOldLogFiles.fileDateThreshold | Maximum age of a file before being marked for removal. | 30 |
rsview.search.endpoint | Set value to specify a full URL enpoint for research's kibana and big desk app tools. | |
RSView ID
Property Name | Description | Default Value |
---|
rsview.id.group | Name of the cluster. | ${CLUSTERNAME} |
rsview.id.description | Description used for license registration. | RSVIEW |
rsview.id.location | IP used for license registration. | ${LOCALHOST} |
RSView GSE
Property Name | Description | Default Value |
---|
rsview.gse.path | Path to groovy script | ${DIST}/tomcat/webapps/resolve/WEB-INF/service |
RSView SQL
Property Name | Description | Default Value |
---|
rsview.ehcache.defaultCache.maxElementsInMemory | Maximum number of the mappings that can be held is earache memory. | 10000 |
rsview.ehcache.defaultCache.eternal | Set to 'true' to ensure that earache mappings never expire. | true |
rsview.ehcache.defaultCache.maxElementsOnDisk | Maximum number of mappings that can be stored on disk. | 10000000 |
rsview.ehcache.defaultCache.diskExpiryThreadIntervalSeconds | The interval in seconds between runs of the disk expiry thread. | 120 |
RSView JTA
Property Name | Description | Default Value |
---|
rsview.jta.log | Path to the parent directory of the jta logs. | ${DIST}/tomcat/logs |
rsview.jta.timeout | Period of time needed for a transaction to timeout. | 600000 |
rsview.jta.max_actives | maximum number of active transactions allowed. | 1500 |
RSView Tomcat
Property Name | Description | Default Value |
---|
rsview.tomcat.server.port | Port for tomcats use. | 8005 |
rsview.tomcat.connector.ajp.port | Port used by tomcat to connect via the ajp protocol. | 8009 |
rsview.tomcat.connector.ajp.redirectport | If this Connector is supporting non-SSL requests, and a request is received for which a matching <security-constraint> requires SSL transport, Catalina will automatically redirect the request to the port number. | 8443 |
rsview.tomcat.http | Set to 'true' to use http as opposed to https. | true |
rsview.tomcat.connector.http.port | Port used by the tomcat http connector. | 8080 |
rsview.tomcat.connector.http.redirectport | If this Connector is supporting non-SSL requests, and a request is received for which a matching <security-constraint> requires SSL transport, Catalina will automatically redirect the request to the port number specified here | 8443 |
rsview.tomcat.https | Set to true if https access is available on this RSView, if true a keystore with a certificate for the RSView must be set up. | false |
rsview.tomcat.connector.https.port | Port used for https connections. | 8443 |
rsview.tomcat.connector.https.keystoreFile | Location of the keystore to use with secure communications | /home/resolve/.keystore |
rsview.tomcat.connector.https.keystorePass | Passphrase used to decrypt the keystore file | resolve |
rsview.tomcat.connector.https.sslEnabledProtocols | The ssl protocol to be used with https. | TLSv1.2 |
rsview.tomcat.connector.https.ciphers | Ciphers used with https. | TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_RC4_128_SHA,TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_256_CBC_SHA256,TLS_RSA_WITH_AES_256_CBC_SHA,SSL_RSA_WITH_RC4_128_SHA,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 |
rsview.tomcat.connector.maxthreads | Maximum amount of active Tomcat threads allowed. | 500 |
rsview.tomcat.connector.compression | Set to 'on' to enable compression set to false to disable compression. | on |
rsview.tomcat.connector.compressionMinSize | Minimum amount of data necessary before output is compressed. | 2048 |
rsview.tomcat.connector.noCompressionUserAgents | Agents with dissabled compression. | Godzilla, traviata |
rsview.tomcat.connector.compressableMimeType | The value is a comma separated list of MIME types for which HTTP compression may be used. | text/html,text/xml,text/javascript,text/css,text/plain,text/json,application/javascript,application/json,application/xml |
rsview.axis2.http | Set to 'true' to use http for SOAP. | ${rsview.tomcat.http} |
rsview.axis2.connector.http.port | The port number for http connections. | ${rsview.tomcat.connector.http.port} |
rsview.axis2.https | Set to 'true' to use https for SOAP. | ${rsview.tomcat.https} |
rsview.axis2.connector.https.port | The port number for https SOAP connections. | ${rsview.tomcat.connector.https.port} |
rsview.web.httpsForward | If 'true' any http connections will be forwarded to https | false |
RSView Web
Property Name | Description | Default Value |
---|
rsview.web.httpsForward | Set to 'true' to use https forwarding for requests. | false |
RSView Hibernate
Property Name | Description | Default Value |
---|
rsview.hibernate.dbtype | Type of database used by Actions Pro. | ${hibernate.dbtype} |
rsview.hibernate.hibernate.default_schema | Schema of the database used. | ${hibernate.default_schema} |
RSView Run
Property Name | Description | Default Value |
---|
rsview.run.R_USER | User to run RSView. | ${resolve.user} |
rsview.run.java_opts | Java options to use when starting up. | |
rsview.run.terminatetimeout | Period of time until run timesout and is terminated. | 30 |
RSView Selfcheck
Property Name | Description | Default Value |
---|
rsview.selfcheck.es.active | Set to 'true' to check the health of Elasticsearch (ES). | false |
rsview.selfcheck.es.retrydelay | Period of time to wait before retrying the ES check. | 10 |
rsview.selfcheck.es.interval | Interval between selfchecks to ES. | 300 |
rsview.selfcheck.es.retry | Period of time for RSView to retry a failed check. | 5 |
rsview.selfcheck.ping.active | Set to 'true' to ping RSRemote from RSView to check its health. | false |
rsview.selfcheck.ping.threshold | Period of time for a check to RSRemote to timeout. | 5 |
rsview.selfcheck.ping.interval | Interval between pings to RSRemote. | 300 |
rsview.selfcheck.db.active | Set to 'true' to check the health of the database from RSView. | false |
rsview.selfcheck.db.interval | Interval between checks to the database. | 300 |
rsview.selfcheck.db.timeout | Period of time until a check to the database to timeout. | 5 |
rsview.selfcheck.ldapadsc.active | Set to 'true' to check the health of LDAP, AD, or SC. | false |
rsview.selfcheck.ldapadsc.interval | Interval between checks to LDAP, AD, SC. | 300 |
rsview.selfcheck.http.active | Set to 'true' to check the health of tomcat. | false |
rsview.selfcheck.http.interval | Interval between checks to tomcat. | 300 |
RSConsole Settings
All RSConsole Settings
The following lists shows the logical groups of RSConsole properties and their default values.
- RSConsole config.xml general configuration
rsconsole.general.home=${DIST}
rsconsole.general.clustername=${CLUSTERNAME}
rsconsole.general.configfileversion=1.0
rsconsole.general.configrevisions=2
rsconsole.general.saveconfigonstart=true
rsconsole.general.saveconfigonexit=true
rsconsole.general.threadkeepalive=30
rsconsole.general.perfdebug=false
rsconsole.general.mcpmode=${MCPMODE}
rsconsole.general.environment=${ENVIRONMENT}rsconsole.general.scheduledpool=100
rsconsole.general.taskExecutor.executorAlarmThreadLimit=1000
- RSConsole Log4j configuration
rsconsole.log4j.Loggers.Root.level=WARN
rsconsole.log4j.Loggers.Root.appender-ref.ref=RSCONSOLE
rsconsole.log4j.Loggers.Logger.com.resolve.rsconsole.level=${rsconsole.log4j.loglevel}
rsconsole.log4j.Loggers.Logger.com.resolve.rsconsole.history.level=INFO
rsconsole.log4j.Loggers.Logger.com.resolve.rsconsole.history.additivity=false
rsconsole.log4j.Loggers.Logger.com.resolve.rsconsole.history.appender-ref.ref=HISTORY
rsconsole.log4j.Loggers.Logger.org.quartz.level=INFO
rsconsole.log4j.Loggers.Logger.syslog.level=INFO
rsconsole.log4j.Loggers.Logger.syslog.additivity=false
rsconsole.log4j.Appenders.RollingFile.RSCONSOLE.fileName=rsconsole/log/rsconsole.log
rsconsole.log4j.Appenders.RollingFile.RSCONSOLE.filePattern=rsconsole/log/$\${date:yyyy-MM}/rsconsole-%d{MM-dd-yyyy}-%i.log.zip
rsconsole.log4j.Appenders.RollingFile.RSCONSOLE.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
rsconsole.log4j.Appenders.RollingFile.RSCONSOLE.SizeBasedTriggeringPolicy.size=32MB
rsconsole.log4j.Appenders.RollingFile.RSCONSOLE.DefaultRolloverStrategy.max=6
rsconsole.log4j.Appenders.RollingFile.HISTORY.fileName=rsconsole/log/history.log
rsconsole.log4j.Appenders.RollingFile.HISTORY.filePattern=rsconsole/log/$\${date:yyyy-MM}/history-%d{MM-dd-yyyy}-%i.log.zip
rsconsole.log4j.Appenders.RollingFile.HISTORY.PatternLayout.pattern=%d %m%n
rsconsole.log4j.Appenders.RollingFile.HISTORY.SizeBasedTriggeringPolicy.size=32MB
rsconsole.log4j.Appenders.RollingFile.HISTORY.DefaultRolloverStrategy.max=6
- RSConsole config.xml ESB information
rsconsole.esb.product=${rsmq.product}
rsconsole.esb.brokeraddr=${RSMQ_EXTERNAL_PRIMARY_HOST}:${RSMQ_EXTERNAL_PRIMARY_PORT}
rsconsole.esb.username=${rsmq.username}
rsconsole.esb.password=${rsmq.password}
rsconsole.esb.domain=domain1
rsconsole.esb.brokername=router1
rsconsole.esb.mgmtaddr=
rsconsole.esb.brokeraddr2=${RSMQ_EXTERNAL_BACKUP_HOST}:${RSMQ_EXTERNAL_BACKUP_PORT}
rsconsole.esb.createqueueretry=30
rsconsole.esb.createqueuewait=10
rsconsole.esb.keepalive=0
rsconsole.esb.maxfailed=10
rsconsole.esb.cachesize=500
rsconsole.esb.flowcontrolstartqueuesize=400
rsconsole.esb.maxmessages=-1
rsconsole.esb.messagettl=1200000
rsconsole.esb.vhost=${rsmq.vhost}
- RSConsole config.xml database information
rsconsole.connection.dbtype=${DB_TYPE}
rsconsole.connection.dbname=${DB_NAME}
rsconsole.connection.host=${DB_HOST}
rsconsole.connection.username=${DB_USERNAME}
rsconsole.connection.password=${DB_PASSWORD}
rsconsole.connection.url=${DB_URL}
- RSConsole users
rsconsole.users.user.username.1=admin
rsconsole.users.user.password.1=resolve
- RSControl JDK environment
rsconsole.env.RSCONSOLEJDK=${resolve.java_home}
RSConsole General
Property Name | Description | Default Value |
---|
rsconsole.general.home | Home directory of RSConsole. | ${DIST} |
rsconsole.general.clustername | Name of the Actions Pro cluster. | ${CLUSTERNAME} |
rsconsole.general.configfileversion | Default version of the configfile. | 1.0 |
rsconsole.general.configrevisions | Number of backups to keep of the config file. | 2 |
rsconsole.general.saveconfigonstart | Set to 'true' to save the config file on start. | true |
rsconsole.general.saveconfigonexit | Set to 'true' to save the config file on exit. | true |
rsconsole.general.maxthread | Maximum number of threads rsconsole can run. | 10 |
rsconsole.general.maxsystemthread | Maximum number of system threads rsconsole can start. | 100 |
rsconsole.general.timezoneT | Time zone for the RSConsole to use. | |
rsconsole.general.threadkeepalive | If the number of threads is greater than the core, this is the maximum time that excess idle threads will wait for new tasks before terminating. | 30 |
rsconsole.general.perfdebug | Set to 'true' to enable performance debugging. | false |
rsconsole.general.mcpmode | The MCP mode for RSControl. | ${MCPMODE} |
RSConsole Log4j
Property Name | Description | Default Value |
---|
rsconsole.log4j.Loggers.Root.level | Defines common log level. | WARN |
rsconsole.log4j.Loggers.Root.appender-ref.ref | | RSCONSOLE |
rsconsole.log4j.Loggers.Logger.com.resolve.rsconsole.level | | ${rsconsole.log4j.loglevel} |
rsconsole.log4j.Loggers.Logger.com.resolve.rsconsole.history.level | | INFO |
rsconsole.log4j.Loggers.Logger.com.resolve.rsconsole.history.additivity | | false |
rsconsole.log4j.Loggers.Logger.com.resolve.rsconsole.history.appender-ref.ref | | HISTORY |
rsconsole.log4j.Loggers.Logger.org.quartz.level | | INFO |
rsconsole.log4j.Loggers.Logger.syslog.level | | INFO |
rsconsole.log4j.Loggers.Logger.syslog.additivity | | false |
rsconsole.log4j.Appenders.RollingFile.RSCONSOLE.fileName | | rsconsole/log/rsconsole.log |
rsconsole.log4j.Appenders.RollingFile.RSCONSOLE.filePattern | | rsconsole/log/$\\${date:yyyy-MM}/rsconsole-%d{MM-dd-yyyy}-%i.log.zip |
rsconsole.log4j.Appenders.RollingFile.RSCONSOLE.PatternLayout.pattern | | %d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n |
rsconsole.log4j.Appenders.RollingFile.RSCONSOLE.SizeBasedTriggeringPolicy.size | | 32MB |
rsconsole.log4j.Appenders.RollingFile.RSCONSOLE.DefaultRolloverStrategy.max | | 6 |
rsconsole.log4j.Appenders.RollingFile.HISTORY.fileName | | rsconsole/log/history.log |
rsconsole.log4j.Appenders.RollingFile.HISTORY.filePattern | | rsconsole/log/$\\${date:yyyy-MM}/history-%d{MM-dd-yyyy}-%i.log.zip |
rsconsole.log4j.Appenders.RollingFile.HISTORY.PatternLayout.pattern | | %d %m%n |
rsconsole.log4j.Appenders.RollingFile.HISTORY.SizeBasedTriggeringPolicy.size | | 32MB |
rsconsole.log4j.Appenders.RollingFile.HISTORY.DefaultRolloverStrategy.max | | 6 |
RSConsole ES
Property Name | Description | Default Value |
---|
rsconsole.esb.product | Product used for RSConsole esb. | ${rsmq.product} |
rsconsole.esb.brokeraddr | Address and port, used by esb for messaging. | ${RSMQ_EXTERNAL_PRIMARY_HOST}:${RSMQ_EXTERNAL_PRIMARY_PORT} |
rsconsole.esb.username | Username used to connect to the esb product. | ${rsmq.username} |
rsconsole.esb.password | Password used to connect to the esb product. | ${rsmq.password} |
rsconsole.esb.domain | deprecated* | domain1 |
rsconsole.esb.brokername | deprecated* | router1 |
rsconsole.esb.mgmtaddr | deprecated* | |
rsconsole.esb.brokeraddr2 | Backup address and port, used by esb for messaging. | ${RSMQ_EXTERNAL_BACKUP_HOST}:${RSMQ_EXTERNAL_BACKUP_PORT} |
rsconsole.esb.createqueueretry | Period of time to wait before retrying to create a queue. | 30 |
rsconsole.esb.createqueuewait | Period of time to wait before creating a queue. | 10 |
rsconsole.esb.keepalive | After how long time to send a keep alive message. | 0 |
rsconsole.esb.maxfailed | Maximum number of failed messages allowed. | 10 |
rsconsole.esb.cachesize | Maximum number of messages that can be cached. | 500 |
rsconsole.esb.flowcontrolstartqueuesize | Number of messages allowed before flow control activates. | 400 |
rsconsole.esb.maxmessages | Maximum number of messages store, a value of -1 means unlimited messages. | 1 |
rsconsole.esb.messagettl | Period of time to keep a message alive. | 600000 |
rsconsole.esb.sslprotocol | Name of the encryption protocol used by rabbitmq, needs to be atleast TLSv1.1. | TLSv1.2 |
rsconsole.esb.vhost | | ${rsmq.vhost} |
RSConsole User
Property Name | Description | Default Value |
---|
rsconsole.users.user.username.1 | Username to connect to the RSConsole (default settings). | admin |
rsconsole.users.user.password.1 | Password used to connect to the RSConsole (default settings). | resolve |
RSConsole Connection
Property Name | Description | Default Value |
---|
rsconsole.connection.dbtype | The type of database RSConsole connect to. | ${DB_TYPE} |
rsconsole.connection.dbname | Name of the database RSConsole is connecting to. | ${DB_NAME} |
rsconsole.connection.host | Address of the database RSConsole in connecting to. | ${DB_HOST} |
rsconsole.connection.username | Username used to connect to the database. | ${DB_USERNAME} |
rsconsole.connection.password | Password used to connect to the database. | ${DB_PASSWORD} |
rsconsole.connection.url | The url used connect to the database. | ${DB_URL} |
RSMgmt Settings
All RSMGMT Settings
The following lists shows the logical groups of RSMgmt properties and their default values.
User that owns RSMgmt installation
rsmgmt.run.R_USER=${resolve.user}
Additional java_option when RSMgmt is run
RSMgmt config.xml general information
rsmgmt.general.home=${DIST}
rsmgmt.general.clustername=${CLUSTERNAME}
rsmgmt.general.configfileversion=1.0
rsmgmt.general.configrevisions=2
rsmgmt.general.saveconfigonstart=true
rsmgmt.general.saveconfigonexit=true
rsmgmt.general.threadkeepalive=30
rsmgmt.general.perfdebug=false
rsmgmt.general.mcpmode=${MCPMODE}
rsmgmt.general.environment=${ENVIRONMENT}
RSMgmt Log4j configuration
rsmgmt.log4j.Loggers.Root.level=WARN
rsmgmt.log4j.Loggers.Root.appender-ref.ref=RSMGMT
rsmgmt.log4j.Loggers.Logger.com.resolve.rsmgmt.level=${rsmgmt.log4j.loglevel}
rsmgmt.log4j.Loggers.Logger.com.resolve.update.level=INFO
rsmgmt.log4j.Loggers.Logger.com.resolve.update.additivity=false
rsmgmt.log4j.Loggers.Logger.com.resolve.update.appender-ref.ref=UPDATE
rsmgmt.log4j.Loggers.Logger.syslog.level=ERROR
rsmgmt.log4j.Loggers.Logger.syslog.additivity=false
rsmgmt.log4j.Appenders.RollingFile.RSMGMT.fileName=rsmgmt/log/rsmgmt.log
rsmgmt.log4j.Appenders.RollingFile.RSMGMT.filePattern=rsmgmt/log/$\${date:yyyy-MM}/rsmgmt-%d{MM-dd-yyyy}-%i.log.zip
rsmgmt.log4j.Appenders.RollingFile.RSMGMT.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
rsmgmt.log4j.Appenders.RollingFile.RSMGMT.SizeBasedTriggeringPolicy.size=32MB
rsmgmt.log4j.Appenders.RollingFile.RSMGMT.DefaultRolloverStrategy.max=6
rsmgmt.log4j.Appenders.RollingFile.UPDATE.fileName=rsmgmt/log/update.log
rsmgmt.log4j.Appenders.RollingFile.UPDATE.filePattern=rsmgmt/log/$\${date:yyyy-MM}/update-%d{MM-dd-yyyy}-%i.log.zip
rsmgmt.log4j.Appenders.RollingFile.UPDATE.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
rsmgmt.log4j.Appenders.RollingFile.UPDATE.Policies.TimeBasedTriggeringPolicy.interval=1
rsmgmt.log4j.Appenders.RollingFile.UPDATE.Policies.TimeBasedTriggeringPolicy.modulate=true
Deprecated. License validation configuration
rsmgmt.license.active=true
#License Master election interval in seconds
rsmgmt.license.election=30
rsmgmt.license.failover=90
RSMgmt config.xml
rsmgmt.esb.product=${rsmq.product}
rsmgmt.esb.brokeraddr=${RSMQ_EXTERNAL_PRIMARY_HOST}:${RSMQ_EXTERNAL_PRIMARY_PORT}
rsmgmt.esb.username=${rsmq.username}
rsmgmt.esb.password=${rsmq.password}
rsmgmt.esb.domain=domain1
rsmgmt.esb.brokername=router1
rsmgmt.esb.mgmtaddr=
rsmgmt.esb.brokeraddr2=${RSMQ_EXTERNAL_BACKUP_HOST}:${RSMQ_EXTERNAL_BACKUP_PORT}
rsmgmt.esb.createqueueretry=30
rsmgmt.esb.createqueuewait=10
rsmgmt.esb.keepalive=0
rsmgmt.esb.maxfailed=10
rsmgmt.esb.cachesize=500
rsmgmt.esb.flowcontrolstartqueuesize=400
rsmgmt.esb.maxmessages=-1
rsmgmt.esb.sslprotocol=TLSv1.2
rsmgmt.esb.connectionTimeout=5000
rsmgmt.esb.vhost=${rsmq.vhost}
RSMgmt queue name
rsmgmt.esb.queue.name.1=RSMGMT
RSMgmt database settings.
You can set rsmgmt.sql.active=true if database testing is not required (RSRemote standalone system), or the local RSMgmt is not the primary RSMgmt.
rsmgmt.sql.active=true
rsmgmt.sql.dbtype=${DB_TYPE}
rsmgmt.sql.dbname=${DB_NAME}
rsmgmt.sql.host=${DB_HOST}
rsmgmt.sql.username=${DB_USERNAME}
rsmgmt.sql.password=${DB_PASSWORD}
rsmgmt.sql.url=${DB_URL
Deprecated. Metric configuration.
The RSMgmt is responsible for receiving metric data gathered by the various other Actions Pro components, and writing it to the database so it can be reported on later. Only the Primary RSMgmt gathers these metrics, so if the Primary RSMgmt is down, then no new reporting data will be gathered (rsmgmt.metric.active=${PRIMARY}
). Advanced RSMgmt metrics configuration from blueprint.properties file is deprecated.
rsmgmt.metric.queue=METRIC
rsmgmt.metric.active=${PRIMARY}
rsmgmt.metric.group.units.1=thread_count,mem_free
rsmgmt.metric.group.name.1=jvm
rsmgmt.metric.group.init.1=true
rsmgmt.metric.group.drop.1=false
rsmgmt.metric.group.type.1=default
rsmgmt.metric.group.units.2=aborted,completed,gcondition,bcondition,ucondition,gseverity,cseverity,wseverity,sseverity,useverity,duration
rsmgmt.metric.group.name.2=runbook
rsmgmt.metric.group.init.2=true
rsmgmt.metric.group.drop.2=false
rsmgmt.metric.group.type.2=default
rsmgmt.metric.group.units.3=transaction,latency
rsmgmt.metric.group.name.3=transaction
rsmgmt.metric.group.init.3=true
rsmgmt.metric.group.drop.3=false
rsmgmt.metric.group.type.3=default
rsmgmt.metric.group.units.4=active
rsmgmt.metric.group.name.4=users
rsmgmt.metric.group.init.4=true
rsmgmt.metric.group.drop.4=false
rsmgmt.metric.group.type.4=default
rsmgmt.metric.group.units.5=load1,load5,load15
rsmgmt.metric.group.name.5=server
rsmgmt.metric.group.init.5=true
rsmgmt.metric.group.drop.5=false
rsmgmt.metric.group.type.5=default
rsmgmt.metric.group.units.6=wiki,wikiresponsetime,social,socialresponsetime
rsmgmt.metric.group.name.6=latency
rsmgmt.metric.group.init.6=true
rsmgmt.metric.group.drop.6=false
rsmgmt.metric.group.type.6=default
rsmgmt.metric.group.units.7=free_space,size,percentage_used,response_time,query_count,percentage_wait
rsmgmt.metric.group.name.7=database
rsmgmt.metric.group.init.7=true
rsmgmt.metric.group.drop.7=false
rsmgmt.metric.group.type.7=default
rsmgmt.metric.group.units.8=status
rsmgmt.metric.group.name.8=cr
rsmgmt.metric.group.init.8=true
rsmgmt.metric.group.drop.8=false
rsmgmt.metric.group.type.8=default
rsmgmt.metric.group.units.9=node_cnt,tot_cnt,tot_time,status:string(20),dtnamespace:string(100)
rsmgmt.metric.group.name.9=dt
rsmgmt.metric.group.init.9=true
rsmgmt.metric.group.drop.9=false
rsmgmt.metric.group.type.9=decisiontree
rsmgmt.metric.group.units.10=endUsers,adminUsers
rsmgmt.metric.group.name.10=licensedusers
rsmgmt.metric.group.init.10=true
rsmgmt.metric.group.drop.10=false
rsmgmt.metric.group.type.10=default
Deprecated. The RSMgmt can send out automatic alerts for various Actions Pro failures through the email gateway, Actions Pro database, the database gateway, and/or snmp traps. Alerts are sent for FATAL level errors (e.g. component is unexpectedly down).
Advanced RSMgmt alerts configuration from blueprint.properties file is deprecated.
rsmgmt.alert.active=true
rsmgmt.alert.snmp.active=false
rsmgmt.alert.snmp.community=public
rsmgmt.alert.snmp.traphost=127.0.0.1
rsmgmt.alert.snmp.trapport=162
rsmgmt.alert.dblog.active=${rsmgmt.sql.active}
rsmgmt.alert.gateway.active=true
rsmgmt.alert.email.active=false
#Email subject in the form "Resolve alert message: $MESSAGE with Severity $SEVERITY."
#where #$MESSAGE and $SEVERITY will be replaced with actual message and severity.
#There are $CODE and $COMPONENT parameters as well and all parameters are optional.
rsmgmt.alert.email.subject=Resolve Alert
rsmgmt.alert.email.body=Severity: $SEVERITY, Component: $COMPONENT, Type: $CODE, Message: $MESSAGE.
rsmgmt.alert.email.to=
rsmgmt.alert.email.cc=
rsmgmt.alert.email.bcc=
RSMgmt registration configuration
rsmgmt.registration.parentguid=RSCONTROL
rsmgmt.registration.expiration=10080
rsmgmt.registration.discard=43200
rsmgmt.registration.interval=5
rsmgmt.registration.logheartbeat=true
RSMgmt Elasticsearch configuration
rsmgmt.search.active=false
rsmgmt.search.serverlist=${rssearch.serverlist}
rsmgmt.search.shards=${rssearch.shards}
rsmgmt.search.replicas=${rssearch.replicas}
rsmgmt.search.indexthreads=${rssearch.indexthreads}
rsmgmt.search.indextimout=${rssearch.indextimout}
rsmgmt.search.indexretries=${rssearch.indexretries}
rsmgmt.search.serverport=${rssearch.yml.transport.tcp.port}
rsmgmt.search.cluster=${rssearch.yml.cluster.name}
rsmgmt.search.clienttype=${rssearch.clienttype}
rsmgmt.search.http=${rssearch.yml.http.enabled}
rsmgmt.search.httpport=${rssearch.yml.http.port}
rsmgmt.search.analytics=false
rsmgmt.search.embedded=false
rsmgmt.search.datadir=${DIST}/tmp/es
#TTL is in seconds, default is 3 months (60*60*24*30*3)
#ES removes system and rss posts based on this
rsmgmt.search.ttl=7776000
RSMgmt ID configuration
rsmgmt.id.group=default
rsmgmt.id.description=RSMGMT
rsmgmt.id.location=${LOCALHOST}
MCP Web Service configuration
rsmgmt.restwebservice.active=true
rsmgmt.restwebservice.username=resolve
rsmgmt.restwebservice.password=resolve
rsmgmt.restwebservice.httpport=8082
rsmgmt.restwebservice.httpsport=8083
rsmgmt.restwebservice.ssl=true
rsmgmt.restwebservice.keystore=${DIST}/rsmgmt/config/restcerts.jks
rsmgmt.restwebservice.keystorepassword=changeit
rsmgmt.restwebservice.keypassword=changeit
MCP configuration
rsmgmt.mcp.active=true
#when component status is asked, wait for these many
#seconds to give up
rsmgmt.mcp.statusrequestexpiration=60
rsmgmt.mcp.registration.enabled=false
rsmgmt.mcp.registration.password=
rsmgmt.mcp.registration.port=
rsmgmt.mcp.registration.protocol=
rsmgmt.mcp.registration.username=
rsmgmt.mcp.registration.uri=
RSMgmt Run
Property Name | Description | Default Value |
---|
rsmgmt.run.R_USER | The name of the user to run the RSMgmt component. | ${resolve.user} |
rsmgmt.run.java_opts | Java options used when starting up the component. | |
rsmgmt.run.terminatetimeout | Period of time before a run is timed out and terminated. | 30 |
RSMgmt General
Property Name | Description | Default Value |
---|
rsmgmt.general.home | Home directory of the RSMgmt component. | ${DIST} |
rsmgmt.general.clustername | Name of the Actions Pro cluster. | ${CLUSTERNAME} |
rsmgmt.general.configfileversion | Default version of the config.xml. | 1.0 |
rsmgmt.general.configrevisions | Numberof backup config.xmls to keep. | 2 |
rsmgmt.general.saveconfigonstart | Set to 'true' to save config.xml on start. | true |
rsmgmt.general.saveconfigonexit | Set to 'true' to save config on exit. | true |
rsmgmt.general.maxthread | Maximum number of active threads RSMgmt can have up. | 100 |
rsmgmt.general.maxsystemthread | Maximum number of system threads RSMgmt can use. | 100 |
rsmgmt.general.timezone | Time zone of the RSMgmt component. | |
rsmgmt.general.threadkeepalive | If the number of threads is greater than the core, this is the maximum timethat excess idle threads will wait for new tasks before terminating. | 30 |
rsmgmt.general.perfdebug | Set to 'true' to enable performance debugging. | false |
rsmgmt.general.mcpmode | The mcp mode of the RSMgmt component. | ${MCPMODE} |
RSMgmt Log4
Property Name | Description | Default Value |
---|
rsmgmt.log4j.Loggers.Root.level | Defines common log level. | WARN |
rsmgmt.log4j.Loggers.Root.appender-ref.ref | | RSMGMT |
rsmgmt.log4j.Loggers.Logger.com.resolve.rsmgmt.level | | {rsmgmt.log4j.loglevel} |
rsmgmt.log4j.Loggers.Logger.com.resolve.update.level | | INFO |
rsmgmt.log4j.Loggers.Logger.com.resolve.update.additivity | | false |
rsmgmt.log4j.Loggers.Logger.com.resolve.update.appender-ref.ref | | UPDATE |
rsmgmt.log4j.Loggers.Logger.syslog.level | | ERROR |
rsmgmt.log4j.Loggers.Logger.syslog.additivity | | false |
rsmgmt.log4j.Appenders.RollingFile.RSMGMT.fileName | | rsmgmt.log4j.Appenders.RollingFile.RSMGMT.fileName |
rsmgmt.log4j.Appenders.RollingFile.RSMGMT.filePattern | | rsmgmt/log/$\\${date:yyyy-MM}/rsmgmt-%d{MM-dd-yyyy}-%i.log.zip |
rsmgmt.log4j.Appenders.RollingFile.RSMGMT.PatternLayout.pattern | | %d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n |
rsmgmt.log4j.Appenders.RollingFile.RSMGMT.SizeBasedTriggeringPolicy.size | | 32MB |
rsmgmt.log4j.Appenders.RollingFile.RSMGMT.DefaultRolloverStrategy.max | | 6 |
rsmgmt.log4j.Appenders.RollingFile.UPDATE.fileName | | rsmgmt/log/update.log |
rsmgmt.log4j.Appenders.RollingFile.UPDATE.filePattern | | rsmgmt/log/$\\${date:yyyy-MM}/update-%d{MM-dd-yyyy}-%i.log.zip |
rsmgmt.log4j.Appenders.RollingFile.UPDATE.PatternLayout.pattern | | %d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n |
rsmgmt.log4j.Appenders.RollingFile.UPDATE.Policies.TimeBasedTriggeringPolicy.interval | | 1 |
rsmgmt.log4j.Appenders.RollingFile.UPDATE.Policies.TimeBasedTriggeringPolicy.modulate | | true |
RSMgmt ESB
Property Name | Description | Default Value |
---|
rsmgmt.esb.product | Name of the messaging application used, do not change unless advised by support. | ${rsmq.product} |
rsmgmt.esb.brokeraddr | Address used by the rabbitmq broker in the host:port format. | ${RSMQ_EXTERNAL_PRIMARY_HOST}:${RSMQ_EXTERNAL_PRIMARY_PORT} |
rsmgmt.esb.username | Username for the rsmq client. | ${rsmq.username} |
rsmgmt.esb.password | Password for the given rsmq username. | ${rsmq.password} |
rsmgmt.esb.domain | deprecated* | domain1 |
rsmgmt.esb.brokername | deprecated* | router1 |
rsmgmt.esb.mgmtaddr | deprecated* | |
rsmgmt.esb.brokeraddr2 | Address of the rabbitmq backup broker in the host:port format | ${RSMQ_EXTERNAL_BACKUP_HOST}:${RSMQ_EXTERNAL_BACKUP_PORT} |
rsmgmt.esb.createqueueretry | Period of time before retrying to create a queue. | 30 |
rsmgmt.esb.createqueuewait | Period of time to wait before creating a queue. | 10 |
rsmgmt.esb.keepalive | After how long time to send a keep alive message. | 0 |
rsmgmt.esb.maxfailed | Maximum number of failed messages allowed. | 10 |
rsmgmt.esb.cachesize | Maximum number of messages cached. | 500 |
rsmgmt.esb.flowcontrolstartqueuesize | Number of messages allowed before flow control activates. | 400 |
rsmgmt.esb.maxmessages | Maximum number of messages store, a value of -1 means unlimited messages. | 1 |
rsmgmt.esb.messagettl | Period of time for a message to live in milliseconds. | 600000 |
rsmgmt.esb.sslprotocol | Name of the encryption protocol used by rabbitmq, needs to be atleast TLSv1.1 | TLSv1.2 |
rsmgmt.esb.queue.name.1 | Queue name for the RSMgmt component. | RSMGMT |
rsmgmt.esb.vhost | | ${rsmq.vhost |
RSMgmt SQL
Property Name | Property Name | Description |
---|
rsmgmt.sql.active | Set to 'true' to activate the database for this component. | true |
rsmgmt.sql.dbtype | The type of database Actions Pro is connected to. | ${DB_TYPE} |
rsmgmt.sql.dbname | Name of the database RSMgmt will connect to. | ${DB_NAME} |
rsmgmt.sql.host | Address of the database RSMgmt is connecting to. | ${DB_HOST} |
rsmgmt.sql.username | Username used to connect to the database. | ${DB_USERNAME} |
rsmgmt.sql.password | Password used to connect to the database. | ${DB_PASSWORD} |
rsmgmt.sql.url | The url of the database. | ${DB_URL} |
rsmgmt.sql.perfdebug | Set to 'true' to enable performace debugging. | false |
RSMgmt Monitor
Property Name | Description | Default Value |
---|
rsmgmt.monitor.local.active | Whether to monitor the local components for UP/DOWN/HANGING status. | true |
rsmgmt.monitor.local.interval | How often to check on the local components (in seconds) | 300 |
rsmgmt.monitor.local.restart | Whether to restart the local components if a HANGING (unexpectedly DOWN) status is detected | false |
rsmgmt.monitor.db.active | Whether to monitor the connection to the Actions Pro database for unavailable or slow connections. | true |
rsmgmt.monitor.db.interval | How often to check the database connectivity (in seconds) | 300 |
rsmgmt.monitor.db.timeout | How long the test query has to take before alerting on a slow connection (in seconds). | 5 |
rsmgmt.monitor.esb.active | Whether to monitor the AMQP connectivity for unavailable or undelivered messages | true |
rsmgmt.monitor.esb.interval | How often to check the AMQP connectivity in seconds. | 300 |
rsmgmt.monitor.stdout.active | Whether to monitor the local connections stdout files (catalina.out for RSView). | true |
rsmgmt.monitor.stdout.interval | How often to check the stdout files for error messages in seconds. | 60 |
rsmgmt.monitor.stdout.file | A file containing the messages that, if in the stdout files, will trigger an alert | stdoutMonitor.txt |
rsmgmt.monitor.rsremote.interval | How often to send AMQP messages to the local RSRemote(s) to check if they are busy. | 300 |
rsmgmt.monitor.rsremote.timeout | How long without a response from the RSRemote before its status is set to inactive, in seconds. | 60 |
rsmgmt.monitor.diskspace.active | Set to 'true' to activate monitoring of diskspace. | true |
rsmgmt.monitor.diskspace.interval | Interval between checking of the available diskspace. | 300 |
rsmgmt.monitor.ping.rsremote | Set to 'true' to enable pinging of rsremote. | false |
rsmgmt.monitor.ping.rscontrol | Set to 'true' to enable pinging of rscontrol. | false |
rsmgmt.monitor.ping.rsview | Set to 'true' to enable pinging of RSView. | false |
rsmgmt.monitor.ping.interval | Interval between pinging of other components. | 300 |
rsmgmt.monitor.ping.threshold | Period of time until a ping to other components to timeout. | 5 |
rsmgmt.monitor.es.active | Set to 'true' to activate monitoring of Elasticsearch. | false |
rsmgmt.monitor.esb.interval | Interval between checks to Elasticsearch. | 300 |
rsmgmt.monitor.es.osmemthresholdprcnt | Elasticsearch maximum ram threshold. | 80 |
rsmgmt.monitor.es.fsmemthresholdprcnt | Elasticsearch maximum hard disk threshold. | 80 |
rsmgmt.monitor.es.jvmheapthresholdprcnt | Elasticsearch maximum java virtual memory threshold. | 80 |
rsmgmt.monitor.es.gcfreqthresholdpersec | Time in between consecutive garbage collection on old objects. | 10 |
rsmgmt.monitor.http.active | Set to 'true' to activate monitoring of http. | false |
rsmgmt.monitor.http.interval | Interval between http checks. | 300 |
rsmgmt.monitor.dbtps.active | Set to 'true' to activate checking of database TPS. | false |
rsmgmt.monitor.dbtps.interval | Interval between checking of database TPS. | 60 |
rsmgmt.monitor.dbtps.threshold | Maximum transactions per second allowed. | 50 |
RSMgmt Registration
Property Name | Description | Default Value |
---|
rsmgmt.registration.parentguid | Guide of parent. | RSCONTROL |
rsmgmt.registration.expiration | Period of time until component registration expires. | 10080 |
rsmgmt.registration.discard | Period of time after registration until a registration is discarded. | 43200 |
rsmgmt.registration.interval | Interval between registration checks. | 5 |
rsmgmt.registration.logheartbeat | Log heartbeat. | true |
RSMgmt Search
Property Name | Description | Default Value |
---|
rsmgmt.search.active | Set to 'true' to give rsmgmt access to Elasticsearch. | true |
rsmgmt.search.serverlist | List of Elasticsearch nodes. | ${rssearch.serverlist} |
rsmgmt.search.shards | Number of shards per index in Elasticsearch. | ${rssearch.shards} |
rsmgmt.search.replicas | Number of Elasticsearch replicas. | ${rssearch.replicas} |
rsmgmt.search.indexthreads | deprecated* | ${rssearch.indexthreads} |
rsmgmt.search.indextimout | Period of time it takes for a request to in index times out. | ${rssearch.indextimout} |
rsmgmt.search.indexretries | Period of time to retry making a request to an index | ${rssearch.indexretries} |
rsmgmt.search.serverport | Port that Elasticsearch uses. | ${rssearch.yml.transport.tcp.port} |
rsmgmt.search.cluster | Name of the Elasticsearch cluster. | ${rssearch.yml.cluster.name} |
rsmgmt.search.clienttype | Set whether clients should be node or transport. | ${rssearch.clienttype} |
rsmgmt.search.http | Set to 'true' to enable http. | ${rssearch.yml.http.enabled} |
rsmgmt.search.httpport | Port Elasticsearch uses for http. | ${rssearch.yml.http.port} |
rsmgmt.search.ttl | Period of time for an index to live. | ${search.ttl} |
rsmgmt.id.group | Name of the Actions Pro cluster. | ${CLUSTERNAME} |
rsmgmt.id.description | Description of this component. | RSMGMT |
rsmgmt.id.location | Address of this component. | ${LOCALHOST} |
RSMgmt Restwebservice
Property Name | Description | Default Value |
---|
rsmgmt.restwebservice.active | Set to 'true' to activate restwebservice. | false |
rsmgmt.restwebservice.username | Username used to connect to the restwebservice. | resolve |
rsmgmt.restwebservice.password | Password used to connect to the restwebservice. | resolve |
rsmgmt.restwebservice.httpport | Port used by the restwebservice for http. | 8082 |
rsmgmt.restwebservice.httpsport | Port used by the restwebservice for https. | 8083 |
rsmgmt.restwebservice.ssl | Set to 'true' to use ssl with the restwebservice. | true |
rsmgmt.restwebservice.keystore | Path to the keystorefile. | ${DIST}/rsmgmt/config/restcerts.jks |
rsmgmt.restwebservice.keystorepassword | Password needed to use the keystore. | changeit |
rsmgmt.restwebservice.keypassword | Password used by the key. | changeit |
RSMgmt MCP
Property Name | Description | Default Value |
---|
rsmgmt.mcp.registration.enabled | Set to 'true' to enable mcp registration. | false |
rsmgmt.mcp.registration.password | Password used for mcp registration. | |
rsmgmt.mcp.registration.port | Port used for mcp registration. | |
rsmgmt.mcp.registration.protocol | Protocol used with mcp registration. | |
rsmgmt.mcp.registration.username | Username user for mcp registration. | |
rsmgmt.mcp.registration.uri | The Uri used when registering with mcp. | |
RSRemote Settings
All RSRemote Settings
The following lists shows the logical groups of RSRemote properties and their default values.
- Specify RSRemote installation information: please consult with Resolve Systems on full procedure for setting up multiple RSRemotes on a single server.
rsremote.instance.count=1
rsremote.instance1.name=rsremote
- RSRemote general configuration
rsremote.general.home=${DIST}
rsremote.general.cluster=false
rsremote.general.configfileversion=1.0
rsremote.general.configrevisions=2
rsremote.general.saveconfigonstart=true
rsremote.general.saveconfigonexit=true
rsremote.general.cronoffset=0
rsremote.general.maxthread=500
rsremote.general.maxsystemthread=500
rsremote.general.timezone=
rsremote.general.threadkeepalive=30
- RSRemote Log4j
rsremote.log4j.Loggers.Root.level=WARN
rsremote.log4j.Loggers.Root.appender-ref.ref=RSREMOTE,amqp
rsremote.log4j.Loggers.Logger.com.resolve.rsremote.level=${rsremote.log4j.loglevel}
rsremote.log4j.Loggers.Logger.com.resolve.dcs.httplogappender.level=INFO
rsremote.log4j.Loggers.Logger.DCS.level=INFO
rsremote.log4j.Loggers.Logger.DCS.appender-ref.ref=DCS
rsremote.log4j.Loggers.Logger.syslog.level=ERROR
rsremote.log4j.Loggers.Logger.syslog.additivity=false
rsremote.log4j.Appenders.RollingFile.name=RSREMOTE
rsremote.log4j.Appenders.RollingFile.fileName=rsremote/log/rsremote.log
rsremote.log4j.Appenders.RollingFile.filePattern=rsremote/log/$\${date:yyyy-MM}/rsremote-%d{MM-dd-yyyy}-%i.log.zip
rsremote.log4j.Appenders.RollingFile.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
rsremote.log4j.Appenders.RollingFile.SizeBasedTriggeringPolicy.size=32MB
rsremote.log4j.Appenders.RollingFile.DefaultRolloverStrategy.max=6
rsremote.log4j.Appenders.AmqpAppender.name=amqp
rsremote.log4j.Appenders.AmqpAppender.threshold=WARN
rsremote.log4j.Appenders.AmqpAppender.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] %X{context} %X{filter} (%F:%L) - %m%n
rsremote.log4j.Appenders.HttpLogAppender.name=DCS
rsremote.log4j.Appenders.HttpLogAppender.charset=utf-8
rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationInstance=update-me
rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationUsername=update-me
rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationPassword=update-me
rsremote.log4j.Appenders.HttpLogAppender.hostAddresses=${RSREMOTE_RSDATALOADER_URL}
rsremote.log4j.Appenders.HttpLogAppender.httpConnectionTimeout=5000
rsremote.log4j.Appenders.HttpLogAppender.httpSOTimeout=1000
rsremote.log4j.Appenders.HttpLogAppender.maxConnections=100
rsremote.log4j.Appenders.HttpLogAppender.templatesToEndpointsMapping=data-collector-template:/api/v1/data/collected,incident-events-template:/api/v1/data/incident/events
rsremote.log4j.Appenders.HttpLogAppender.threadCount=10
rsremote.log4j.Appenders.HttpLogAppender.PatternLayout.pattern=%m
rsremote.log4j.Appenders.HttpLogAppender.enabled=false
rsremote.log4j.Appenders.HttpLogAppender.sslEnabled=${RSREMOTE_SSL_ENABLED}
rsremote.log4j.Appenders.HttpLogAppender.sslVerify=${RSREMOTE_SSL_VERIFY}
rsremote.log4j.Appenders.HttpLogAppender.trustStore=${RSREMOTE_TRUSTSTORE_PATH}
rsremote.log4j.Appenders.HttpLogAppender.trustStorePassword=${RSREMOTE_TRUSTSTORE_PASSWORD}
rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationInstance=${RSREMOTE_RSDATALOADER_URL}/login
rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationUsername=rsremote
rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationPassword=
- RSRemote config.xml ESB information
rsremote.esb.product=${rsmq.product}
rsremote.esb.brokeraddr=${RSMQ_EXTERNAL_PRIMARY_HOST}:${RSMQ_EXTERNAL_PRIMARY_PORT}
rsremote.esb.username=${rsmq.username}
rsremote.esb.password=${rsmq.password}
rsremote.esb.domain=domain1
rsremote.esb.brokername=router1
rsremote.esb.mgmtaddr=
rsremote.esb.brokeraddr2=${RSMQ_EXTERNAL_BACKUP_HOST}:${RSMQ_EXTERNAL_BACKUP_PORT}
rsremote.esb.createqueueretry=30
rsremote.esb.createqueuewait=10
rsremote.esb.keepalive=0
rsremote.esb.maxfailed=10
rsremote.esb.cachesize=500
rsremote.esb.flowcontrolstartqueuesize=400
rsremote.esb.maxmessages=-1
rsremote.esb.messagettl=1200000
rsremote.esb.vhost=${rsmq.vhost}
- RSRemote registration configuration
rsremote.registration.logheartbeat=true
- RSRemote ID configuration
rsremote.id.group=default
rsremote.id.description=RSREMOTE
rsremote.id.location=${LOCALHOST}
- RSRemote Elasticsearch configuration
rsremote.search.active=false
rsremote.search.serverlist=${rssearch.serverlist}
rsremote.search.shards=${rssearch.shards}
rsremote.search.replicas=${rssearch.replicas}
rsremote.search.indexthreads=${rssearch.indexthreads}
rsremote.search.indextimout=${rssearch.indextimout}
rsremote.search.indexretries=${rssearch.indexretries}
rsremote.search.serverport=${rssearch.yml.transport.tcp.port}
rsremote.search.cluster=${rssearch.yml.cluster.name}
rsremote.search.clienttype=${rssearch.clienttype}
rsremote.search.http=${rssearch.yml.http.enabled}
rsremote.search.httpport=${rssearch.yml.http.port}
rsremote.search.analytics=false
rsremote.search.embedded=false
rsremote.search.datadir=${DIST}/tmp/es
#TTL is in seconds, default is 3 months (60*60*24*30*3)
#ES removes system and rss posts based on this
rsremote.search.ttl=7776000
- User that owns RSRemote installation
rsremote.run.R_USER=${resolve.user}
- Additional java option when RSRemote is run
RSRemote Instance
Property Name | Description | Default Value |
---|
rsremote.instance.count | Number of rsremote instances | 1 |
RSRemote Instance1
Property Name | Description | Default Value |
---|
rsremote.instance1.name | Name of the rsremote instance one | rsremote |
RSRemote General
Property Name | Description | Default Value |
---|
rsremote.general.home | Home directory of the rsremote component. | ${DIST} |
rsremote.general.clustername | Name of the Actions Pro cluster. | ${CLUSTERNAME} |
rsremote.general.cluster | Set to 'true' to enable clustering in rsremote. | false |
rsremote.general.configfileversion | Default version of the rsremote config.xml. | 1.0 |
rsremote.general.configrevisions | Number of backup to keep of the config.xml. | 2 |
rsremote.general.saveconfigonstart | Save the config.xml on start-up. | true |
rsremote.general.saveconfigonexit | Save the config.xml on exit. | true |
rsremote.general.cronoffset | Period of time to offset cron jobs. | 0 |
rsremote.general.maxthread | Maximum number of threads rsremote can have active at one time. | 500 |
rsremote.general.maxsystemthread | Maximum number of system threads rsremote can have active. | 500 |
rsremote.general.timezone | RSRemote's time zone. | |
rsremote.general.threadkeepalive | If the number of threads is greater than the core, this is the maximum timethat excess idle threads will wait for new tasks before terminating. | 30 |
rsremote.general.perfdebug | Set to 'true' to enable performance debugging. | false |
rsremote.general.mcpmode | The mcp mode of the rsremote component. | ${MCPMODE} |
RSRemote Log4j
Property Name | Description | Default Value |
---|
rsremote.log4j.Loggers.Root.level | Defines common log level. | WARN |
rsremote.log4j.Loggers.Root.appender-ref.ref | | RSREMOTE,amqp |
rsremote.log4j.Loggers.Logger.com.resolve.rsremote.level | | ${rsremote.log4j.loglevel} |
rsremote.log4j.Loggers.Logger.com.resolve.dcs.httplogappender.level | | INFO |
rsremote.log4j.Loggers.Logger.DCS.level | | INFO |
rsremote.log4j.Loggers.Logger.DCS.appender-ref.ref | | DCS |
rsremote.log4j.Loggers.Logger.syslog.level | | ERROR |
rsremote.log4j.Loggers.Logger.syslog.additivity | | false |
rsremote.log4j.Appenders.RollingFile.name | | REMOTE |
rsremote.log4j.Appenders.RollingFile.fileName | | rsremote/log/rsremote.log |
rsremote.log4j.Appenders.RollingFile.filePattern | | rsremote/log/$\\${date:yyyy-MM}/rsremote-%d{MM-dd-yyyy}-%i.log.zip |
rsremote.log4j.Appenders.RollingFile.PatternLayout.pattern | | %d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n |
rsremote.log4j.Appenders.RollingFile.SizeBasedTriggeringPolicy.size | | 32MB |
rsremote.log4j.Appenders.RollingFile.DefaultRolloverStrategy.max | | 6 |
rsremote.log4j.Appenders.AmqpAppender.name | | amqp |
rsremote.log4j.Appenders.AmqpAppender.threshold | | WARN |
rsremote.log4j.Appenders.AmqpAppender.PatternLayout.pattern | | %d{ISO8601}{GMT+0} %5p [%t] %X{context} %X{filter} (%F:%L) - %m%n |
rsremote.log4j.Appenders.HttpLogAppender.name | | DCS |
rsremote.log4j.Appenders.HttpLogAppender.charset | | utf-8 |
rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationInstance | | |
rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationUsername | | |
rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationPassword | | |
rsremote.log4j.Appenders.HttpLogAppender.hostAddresses | | ${RSREMOTE_RSDATALOADER_URL} |
rsremote.log4j.Appenders.HttpLogAppender.httpConnectionTimeout | | 5000 |
rsremote.log4j.Appenders.HttpLogAppender.httpSOTimeout | | 1000 |
rsremote.log4j.Appenders.HttpLogAppender.maxConnections | | 100 |
rsremote.log4j.Appenders.HttpLogAppender.templatesToEndpointsMapping | | data-collector-template:/api/v1/data/collected,incident-events-template:/api/v1/data/incident/events |
rsremote.log4j.Appenders.HttpLogAppender.threadCount | | 10 |
rsremote.log4j.Appenders.HttpLogAppender.PatternLayout.pattern | | %m |
rsremote.log4j.Appenders.HttpLogAppender.enabled | | false |
rsremote.log4j.Appenders.HttpLogAppender.sslEnabled | | ${RSREMOTE_SSL_ENABLED} |
rsremote.log4j.Appenders.HttpLogAppender.sslVerify | | ${RSREMOTE_SSL_VERIFY} |
rsremote.log4j.Appenders.HttpLogAppender.trustStore | | ${RSREMOTE_TRUSTSTORE_PATH} |
rsremote.log4j.Appenders.HttpLogAppender.trustStorePassword | | ${RSREMOTE_TRUSTSTORE_PASSWORD} |
rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationInstance | | ${RSREMOTE_RSDATALOADER_URL} /login |
rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationUsername | | rsremote |
rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationPassword | | |
RSRemote ESB
Property Name | Description | Default Value |
---|
rsremote.esb.product | Product used for the rsremote esb. | ${rsmq.product} |
rsremote.esb.brokeraddr | Address and port used for messaging. | ${RSMQ_EXTERNAL_PRIMARY_HOST}:${RSMQ_EXTERNAL_PRIMARY_PORT} |
rsremote.esb.username | Username used to connect to the esb product. | ${rsmq.username} |
rsremote.esb.password | Password used to connect to the esb product. | ${rsmq.password} |
rsremote.esb.domain | deprecated* | domain1 |
rsremote.esb.brokername | deprecated* | router1 |
rsremote.esb.mgmtaddr | deprecated* | |
rsremote.esb.brokeraddr2 | Backup address and port used for messaging. | ${RSMQ_EXTERNAL_BACKUP_HOST}:${RSMQ_EXTERNAL_BACKUP_PORT} |
rsremote.esb.createqueueretry | Period of time to retry creating a queue. | 30 |
rsremote.esb.createqueuewait | Period of time to wait before creating a queue. | 10 |
rsremote.esb.keepalive | After how long time to send a keep alive message. | 0 |
rsremote.esb.maxfailed | Maximum amount of failed messaged allowed. | 10 |
rsremote.esb.cachesize | Maximum number of messages that can be cached. | 500 |
rsremote.esb.flowcontrolstartqueuesize | Maximum number of messages allowed before flow control starts. | 400 |
rsremote.esb.maxmessages | Maximum number of messages allowed -1 means unlimited. | 1 |
rsremote.esb.messagettl | The message time to live. | 600000 |
rsremote.esb.sslprotocol | The ssl protocol used must be atleast TLSv1.1. | TLSv1.2 |
rsremote.esb.vhost | | ${rsmq.vhost} |
RSRemote Registration
Property Name | Description | Default Value |
---|
rsremote.registration.parentguid | Guide of rsremotes parent component. | RSCONTROL |
rsremote.registration.expiration | Period of time until component registration expires. | 10080 |
rsremote.registration.discard | Period of time to wait until an expired registation is discarded. | 43200 |
rsremote.registration.interval | Interval in minutes for sending of heartbeats. | 5 |
rsremote.registration.logheartbeat | The log each heartbeat sent. | true |
RSRemote Search
Property Name | Description | Default Value |
---|
rsremote.search.active | Set to 'true' to activate use of Elasticsearch in rsremote. | false |
rsremote.search.serverlist | List of each elasticsearch node. | ${rssearch.serverlist} |
rsremote.search.shards | Number of shards in each index. | ${rssearch.shards} |
rsremote.search.replicas | Number of replicas kept by elasticsearch. | ${rssearch.replicas} |
rsremote.search.indexthreads | deprecated* | ${rssearch.indexthreads} |
rsremote.search.indextimout | Period of time it takes for a request to an index takes to timeout. | ${rssearch.indextimout} |
rsremote.search.indexretries | Period of times to retry a request to an index. | ${rssearch.indexretries} |
rsremote.search.serverport | Port used by elasticsearch. | ${rssearch.yml.transport.tcp.port} |
rsremote.search.cluster | Name of the elasticsearch cluster. | ${rssearch.yml.cluster.name} |
rsremote.search.clienttype | Set whether clients should be node or transport. | ${rssearch.clienttype} |
rsremote.search.http | Set to 'true' to enable http in elasticsearch. | ${rssearch.yml.http.enabled} |
rsremote.search.httpport | Port elasticsearch uses for http calls. | ${rssearch.yml.http.port} |
rsremote.search.ttl | Period of time for an index to live. | ${search.ttl} |
RSRemote ID
Property Name | Description | Default Value |
---|
rsremote.id.group | Name of the Actions Pro cluster. | ${CLUSTERNAME} |
rsremote.id.description | Description of the rsremote component. | RSREMOTE |
rsremote.id.location | Address of the rsremote. | ${LOCALHOST} |
RSRemote Run
Property Name | Description | Default Value |
---|
rsremote.run.R_USER | User to run rsremote. | ${resolve.user} |
rsremote.run.java_opts | Extra java options used when running rsremote. | |
rsremote.run.terminatetimeout | Period of time before a run is timedout and terminated. | 600 |
The following lists shows the logical groups of RSSync properties and their default values.
User that owns RSSync installation
rssync.run.R_USER=${resolve.user}
Additional java option when RSSync is run
rssync.run.java_opts=
rssync.run.terminatetimeout=30
RSSync JDK environment
rssync.env.RSSYNCJDK=${resolve.java_home}
RSRemote general configuration
rssync.general.home=${DIST}
rssync.general.clustername=${CLUSTERNAME}
#this is used when multiple RSSyncs are deployed to balance load. In that case this list will be divided among the RSSync.
#DO NOT list same item in multiple RSSyncs.
rssync.general.synclogs=synclog_misc,synclog_socialpost,synclog_systempost,synclog_tag,synclog_worksheet,synclog_processrequest,synclog_taskresult,synclog_pbnotes,synclog_pbauditlog,synclog_pbartifacts,synclog_pbattachment,synclog_pbactivity
rssync.general.syncinterval=10000
rssync.general.syncsize=1000
rssync.general.mcpmode=${MCPMODE}
rssync.general.environment=${ENVIRONMENT}
RSRemote Log4j configuration
rssync.log4j.Loggers.Root.level=${rssync.log4j.loglevel}
rssync.log4j.Loggers.Root.appender-ref.ref=UPDATE
rssync.log4j.Loggers.Logger.com.resolve.rssync.level=${rssync.log4j.loglevel}
rssync.log4j.Loggers.Logger.com.resolve.rssync.additivity=false
rssync.log4j.Loggers.Logger.com.resolve.rssync.appender-ref.ref=RSSYNC
rssync.log4j.Loggers.Logger.com.resolve.update.level=INFO
rssync.log4j.Loggers.Logger.syslog.level=ERROR
rssync.log4j.Loggers.Logger.syslog.additivity=false
rssync.log4j.Appenders.RollingFile.RSSYNC.fileName=rssync/log/rssync.log
rssync.log4j.Appenders.RollingFile.RSSYNC.filePattern=rssync/log/$\${date:yyyy-MM}/rssync-%d{MM-dd-yyyy}-%i.log.zip
rssync.log4j.Appenders.RollingFile.RSSYNC.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
rssync.log4j.Appenders.RollingFile.RSSYNC.SizeBasedTriggeringPolicy.size=32MB
rssync.log4j.Appenders.RollingFile.RSSYNC.DefaultRolloverStrategy.max=6
rssync.log4j.Appenders.RollingFile.UPDATE.fileName=rssync/log/update.log
rssync.log4j.Appenders.RollingFile.UPDATE.filePattern=rssync/log/$\${date:yyyy-MM}/update-%d{MM-dd-yyyy}-%i.log.zip
rssync.log4j.Appenders.RollingFile.UPDATE.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
rssync.log4j.Appenders.RollingFile.UPDATE.Policies.TimeBasedTriggeringPolicy.interval=1
rssync.log4j.Appenders.RollingFile.UPDATE.Policies.TimeBasedTriggeringPolicy.modulate=true
RSSync config.xml ESB information
rssync.esb.product=${rsmq.product}
rssync.esb.brokeraddr=${RSMQ_EXTERNAL_PRIMARY_HOST}:${RSMQ_EXTERNAL_PRIMARY_PORT}
rssync.esb.username=${rsmq.username}
rssync.esb.password=${rsmq.password}
rssync.esb.domain=domain1
rssync.esb.brokername=router1
rssync.esb.mgmtaddr=
rssync.esb.brokeraddr2=${RSMQ_EXTERNAL_BACKUP_HOST}:${RSMQ_EXTERNAL_BACKUP_PORT}
rssync.esb.createqueueretry=30
rssync.esb.createqueuewait=10
rssync.esb.keepalive=0
rssync.esb.maxfailed=10
rssync.esb.cachesize=500
rssync.esb.maxmessages=-1
rssync.esb.sslprotocol=TLSv1.2
rssync.esb.connectionTimeout=5000
rssync.esb.vhost=${rsmq.vhost}
RSSync Elasticsearch configuration
rssync.search.active=true
rssync.search.serverlist=${rssearch.serverlist}
rssync.search.shards=${rssearch.shards}
rssync.search.replicas=${rssearch.replicas}
rssync.search.indexthreads=${rssearch.indexthreads}
rssync.search.indextimout=${rssearch.indextimout}
rssync.search.indexretries=${rssearch.indexretries}
rssync.search.serverport=${rssearch.yml.transport.tcp.port}
rssync.search.compress=${rssearch.yml.transport.tcp.compress}
rssync.search.cluster=${rssearch.yml.cluster.name}
rssync.search.clienttype=${rssearch.clienttype}
rssync.search.http=${rssearch.yml.http.enabled}
rssync.search.httpport=${rssearch.yml.http.port}
rssync.search.scrollctxkeepalivedurationinminutes=${rssearch.scrollctxkeepalivedurationinminutes}
#site to site replication config
rssync.search.sync=${rssearch.sync}
rssync.search.synccluster=${rssearch.synccluster}
rssync.search.syncserverlist=${rssearch.syncserverlist}
rssync.search.syncserverport=${rssearch.syncserverport}
RSSync database settings
rssync.sql.active=true
rssync.sql.dbtype=${DB_TYPE}
rssync.sql.dbname=${DB_NAME}
rssync.sql.host=${DB_HOST}
rssync.sql.username=${DB_USERNAME}
rssync.sql.password=${DB_PASSWORD}
rssync.sql.url=${DB_URL}
rssync.sql.perfdebug=false
RSSync keyservice configiration
rssync.keyservice.proto=${KEYSERVICE_PROTO}
rssync.keyservice.host=${KEYSERVICE_HOST}
rssync.keyservice.port=${KEYSERVICE_PORT}
rssync.keyservice.username=${KEYSERVICE_USERNAME}
rssync.keyservice.pwd=${KEYSERVICE_PWD}
Property Name | Description | Default Value |
---|
rssync.general.home | Home directory of the rssync component. | ${DIST} |
rssync.general.clustername | Name of the RSSEARCH cluster. | ${CLUSTERNAME} |
rssync.general.syncinterval | Interval between syncs. | 10000 |
rssync.general.synclogs | Indecies that this rssync instance should sync with in elasticsearch. Do not list the same item in multiple rssyncs. | synclog_misc,synclog_socialpost,synclog_systempost,synclog_tag,synclog_worksheet,synclog_processrequest,synclog_taskresult |
rssync.general.syncsize | Maxmimum number of entryies that can be synced in one batch. | 1000 |
rssync.general.mcpmode | Mcpmode of the rssync component. | ${MCPMODE} |
Property Name | Description | Default Value |
---|
rssync.log4j.Loggers.Root.level | | ${rssync.log4j.loglevel} |
rssync.log4j.Loggers.Root.appender-ref.ref | | UPDATE |
rssync.log4j.Loggers.Logger.com.resolve.rssync.level | | ${rssync.log4j.loglevel} |
rssync.log4j.Loggers.Logger.com.resolve.rssync.additivity | | false |
rssync.log4j.Loggers.Logger.com.resolve.rssync.appender-ref.ref | | RSSYNC |
rssync.log4j.Loggers.Logger.com.resolve.update.level | | INFO |
rssync.log4j.Loggers.Logger.syslog.level | | ERROR |
rssync.log4j.Loggers.Logger.syslog.additivity | | false |
rssync.log4j.Appenders.RollingFile.RSSYNC.fileName | | rssync/log/rssync.log |
rssync.log4j.Appenders.RollingFile.RSSYNC.filePattern | | rssync/log/$\\${date:yyyy-MM}/rssync-%d{MM-dd-yyyy}-%i.log.zip |
rssync.log4j.Appenders.RollingFile.RSSYNC.PatternLayout.pattern | | %d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n |
rssync.log4j.Appenders.RollingFile.RSSYNC.SizeBasedTriggeringPolicy.size | | 32MB |
rssync.log4j.Appenders.RollingFile.RSSYNC.DefaultRolloverStrategy.max | | 6 |
rssync.log4j.Appenders.RollingFile.UPDATE.fileName | | rssync/log/update.log |
rssync.log4j.Appenders.RollingFile.UPDATE.filePattern | | rssync/log/$\\${date:yyyy-MM}/update-%d{MM-dd-yyyy}-%i.log.zip |
rssync.log4j.Appenders.RollingFile.UPDATE.PatternLayout.pattern | | %d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n |
rssync.log4j.Appenders.RollingFile.UPDATE.Policies.TimeBasedTriggeringPolicy.interval | | 1 |
rssync.log4j.Appenders.RollingFile.UPDATE.Policies.TimeBasedTriggeringPolicy.modulate | | true |
Property Name | Description | Default Value |
---|
rssync.search.active | Set to 'true' to activate elasticsearch in rssync. | true |
rssync.search.serverlist | List of elasticsearch nodes. | ${rssearch.serverlist} |
rssync.search.shards | Number of shards per index. | ${rssearch.shards} |
rssync.search.replicas | Number of replicas in elasticsearch. | ${rssearch.replicas} |
rssync.search.indexthreads | deprecated* | ${rssearch.indexthreads} |
rssync.search.indextimout | Period of time it takes for a request to an index to timeout | ${rssearch.indextimout} |
rssync.search.indexretries | Period of time to retry a request to an index. | ${rssearch.indexretries} |
rssync.search.serverport | Port used by elasticsearch for tcp transport. | ${rssearch.yml.transport.tcp.port} |
rssync.search.cluster | Name of the elasticsearch cluster. | ${rssearch.yml.cluster.name} |
rssync.search.clienttype | Set whether clients should be node or transport. | ${rssearch.clienttype} |
rssync.search.http | Set to 'true' to enable http in elastic search. | ${rssearch.yml.http.enabled} |
rssync.search.httpport | Port used by elastic search for http. | ${rssearch.yml.http.port} |
rssync.search.ttl | Time for each index to live. | ${search.ttl} |
rssync.search.sync | Set to 'true' to sync rssearch nodes. | ${rssearch.sync} |
rssync.search.synccluster | Name of the remote cluster used for discovery. | ${rssearch.synccluster} |
rssync.search.syncserverlist | Name of each node to sync. | ${rssearch.syncserverlist} |
rssync.search.syncserverport | Port used when syncing elasticsearch nodes. | ${rssearch.syncserverport} |
rssync.esb.vhost | | ${rsmq.vhost} |
RSArchive Settings
All RSArchive Settings
The following lists shows the logical groups of RSARchive properties and their default values.
- User that owns RSSync installation
rsarchive.run.R_USER=${resolve.user}
- Additional java option when RSArchive is run
- RSArchive JDK environment
rsarchive.env.RSARCHIVEJDK=${resolve.java_home}
- RSArchive general configuration
rsarchive.general.home=${DIST}
rsarchive.general.clustername=${CLUSTERNAME}
rsarchive.general.configfileversion=1.0
rsarchive.general.configrevisions=2
rsarchive.general.saveconfigonstart=true
rsarchive.general.saveconfigonexit=true
rsarchive.general.savecrononexit=false
rsarchive.general.cronoffset=0
rsarchive.general.snmptraphost=
rsarchive.general.snmptrapport=162
rsarchive.general.threadkeepalive=30
rsarchive.general.perfdebug=false
rsarchive.general.executorbusyratio=0.9
rsarchive.general.sysexecutorbusyratio=0.9
rsarchive.general.startexecutorbusyratio=0.9
rsarchive.general.dbpoolbusyratio=0.9
rsarchive.general.maxrunbooklimit=400
rsarchive.general.minrunbooklimit=1
rsarchive.general.userunbookcount=false
rsarchive.general.mcpmode=${MCPMODE}
- RSArchive Log4j configuration
rsarchive.log4j.Loggers.Root.level=WARN
rsarchive.log4j.Loggers.Root.appender-ref.ref=RSARCHIVE
rsarchive.log4j.Loggers.Logger.com.resolve.rsarchive.level=${rsarchive.log4j.loglevel}
rsarchive.log4j.Loggers.Logger.com.mchange.v2.level=INFO
rsarchive.log4j.Appenders.RollingFile.RSARCHIVE.fileName=rsarchive/log/rsarchive.log
rsarchive.log4j.Appenders.RollingFile.RSARCHIVE.filePattern=rsarchive/log/$\${date:yyyy-MM}/rsarchive-%d{MM-dd-yyyy}-%i.log.zip
rsarchive.log4j.Appenders.RollingFile.RSARCHIVE.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
rsarchive.log4j.Appenders.RollingFile.RSARCHIVE.SizeBasedTriggeringPolicy.size=32MB
rsarchive.log4j.Appenders.RollingFile.RSARCHIVE.DefaultRolloverStrategy.max=6
- RSArchive database settings
rsarchive.sql.dbtype=${DB_TYPE}
rsarchive.sql.dbname=${DB_NAME}
rsarchive.sql.host=${DB_HOST}
rsarchive.sql.username=${DB_USERNAME}
rsarchive.sql.password=${DB_PASSWORD}
rsarchive.sql.url=${DB_URL}
rsarchive.sql.maxpoolsize=100
rsarchive.sql.minpoolsize=${rsarchive.sql.maxpoolsize}
rsarchive.sql.maxidletime=60
rsarchive.sql.perfdebug=false
rsarchive.sql.usexadatasource=true
- RSArchive key service configuration
rsarchive.keyservice.proto=${KEYSERVICE_PROTO}
rsarchive.keyservice.host=${KEYSERVICE_HOST}
rsarchive.keyservice.port=${KEYSERVICE_PORT}
rsarchive.keyservice.username=${KEYSERVICE_USERNAME}
rsarchive.keyservice.pwd=${KEYSERVICE_PWD}
- RSArchive ID configuration
rsarchive.id.group=${CLUSTERNAME}
rsarchive.id.description=RSARCHIVE
rsarchive.id.location=${LOCALHOST}
- RSArchive hibernate configuration
rsarchive.hibernate.dbtype=${hibernate.dbtype}
rsarchive.hibernate.hibernate.default_schema=${hibernate.default_schema}
- RSArchive archival configuration
rsarchive.archive.active=true
rsarchive.archive.schedule=0 0 2 * * ?
rsarchive.archive.expiry=30
rsarchive.archive.cleanup=60
#number of records to be inserted/deleted as a block.
rsarchive.archive.blocksize = 10000
#currently for resolve_process_request and worksheet tables.
rsarchive.archive.smalltableblocksize = 2000
- RSArchive Elasticsearch configuration
rsarchive.search.active=true
rsarchive.search.serverlist=${rssearch.serverlist}
rsarchive.search.shards=${rssearch.shards}
rsarchive.search.replicas=${rssearch.replicas}
rsarchive.search.indexthreads=${rssearch.indexthreads}
rsarchive.search.indextimout=${rssearch.indextimout}
rsarchive.search.indexretries=${rssearch.indexretries}
rsarchive.search.serverport=${rssearch.yml.transport.tcp.port}
rsarchive.search.compress=${rssearch.yml.transport.tcp.port}
rsarchive.search.cluster=${rssearch.yml.cluster.name}
rsarchive.search.clienttype=${rssearch.clienttype}
rsarchive.search.http=${rssearch.yml.http.enabled}
rsarchive.search.httpport=${rssearch.yml.http.port}
rsarchive.search.searchguard=${rssearch.searchguard}
rsarchive.search.sgkeystore=${rssearch.sgkeystore}
rsarchive.search.sgkeystorepwd=${rssearch.sgkeystorepwd}
rsarchive.search.sgtruststore=${rssearch.sgtruststore}
rsarchive.search.sgtruststorepwd=${rssearch.sgtruststorepwd}
Actions Pro Imports
Property Name | Description | Default Value |
---|
resolve.import | default imports to import upon install | users, system, social, default, resolvex, content, gateway, cr, rsutil, reports, rx-customercare, rx-home, doc, automationbuilder |
ESAPI Control
Property Name | Description |
---|
.ESAPI.AccessControl | org.owasp.esapi.reference.DefaultAccessController |
ESAPI Authenticator
Property Name | Default Value |
---|
.ESAPI.Authenticator | org.owasp.esapi.reference.FileBasedAuthenticator |
.ESAPI.Authenticator.AllowedLoginAttempts | 3 |
.ESAPI.Authenticator.MaxOldPasswordHashes | ENC1:EEI2QIlq5xRidWB+DTcv9A== |
.ESAPI.Authenticator.UsernameParameterName | username |
.ESAPI.Authenticator.PasswordParameterName | ENC1:XyBuox2SKKzdSIQR6QsxTg== |
.ESAPI.Authenticator.RememberTokenDuration | 14 |
.ESAPI.Authenticator.IdleTimeoutDuration | 20 |
.ESAPI.Authenticator.AbsoluteTimeoutDuration | 120 |
ESAPI Encoder
Property Name | Default Value |
---|
.ESAPI.Encoder | org.owasp.esapi.reference.DefaultEncoder |
.ESAPI.Encoder.AllowMultipleEncoding | false |
.ESAPI.Encoder.DefaultCodecList | HTMLEntityCodec,PercentCodec,JavaScriptCodec |
ESAPI Encryptor
Property Name | Default Value |
---|
.ESAPI.Encryptor.PreferredJCEProvider | |
.ESAPI.Encryptor.EncryptionAlgorithm | AES |
.ESAPI.Encryptor.CipherTransformation | AES/CBC/PKCS5Padding |
.ESAPI.Encryptor.cipher_modes.combined_modes | GCM,CCM,IAPM,EAX,OCB,CWC |
.ESAPI.Encryptor.cipher_modes.additional_allowed | CBC |
.ESAPI.Encryptor.EncryptionKeyLength | 128 |
.ESAPI.Encryptor | org.owasp.esapi.reference.crypto.JavaEncryptor |
.ESAPI.Encryptor.ChooseIVMethod | random |
.ESAPI.Encryptor.fixedIV | 0x000102030405060708090a0b0c0d0e0f |
.ESAPI.Encryptor.CipherText.useMAC | true |
.ESAPI.Encryptor.PlainText.overwrite | true |
.ESAPI.Encryptor.HashAlgorithm | SHA-512 |
.ESAPI.Encryptor.HashIterations | 1024 |
.ESAPI.Encryptor.DigitalSignatureAlgorithm | SHA1withDSA |
.ESAPI.Encryptor.DigitalSignatureKeyLength | 1024 |
.ESAPI.Encryptor.RandomAlgorithm | SHA1PRNG |
.ESAPI.Encryptor.CharacterEncoding | UTF-8 |
.ESAPI.Encryptor.KDF.PRF | HmacSHA256 |
ESAPI Executor
Property Name | Default Value |
---|
.ESAPI.Executor | org.owasp.esapi.reference.DefaultExecutor |
.ESAPI.Executor.WorkingDirectory | C:\WindowsTemp |
.ESAPI.Executor.ApprovedExecutables | C:\Windows\System32\cmd.exe,C:\Windows\System32runas.exe |
ESAPI
Property Name | Default Value |
---|
.ESAPI.HTTPUtilities | org.owasp.esapi.reference.DefaultHTTPUtilities |
.ESAPI.HttpUtilities.UploadDir | C:\ESAPItestUpload |
.ESAPI.HttpUtilities.UploadTempDir | C:temp |
.ESAPI.HttpUtilities.ForceHttpOnlySession | false |
.ESAPI.HttpUtilities.ForceSecureSession | false |
.ESAPI.HttpUtilities.ForceHttpOnlyCookies | false |
.ESAPI.HttpUtilities.ForceSecureCookies | ${rsview.tomcat.https} |
.ESAPI.HttpUtilities.MaxHeaderSize | 4096 |
.ESAPI.HttpUtilities.ApprovedUploadExtensions | .zip,.pdf,.doc,.docx,.ppt,.pptx,.tar,.gz,.tgz,.rar,.war,.jar,.ear,.xls,.rtf,.properties,.java,.class,.txt,.xml,.jsp,.jsf,.exe,.dll,.conf,.cfg,.bak,.1,.2,.log,.lic,.png,.jpg,.ico,.csv,.json,.css,.vm,.maint,.groovy,.cons |
.ESAPI.HttpUtilities.MaxUploadFileBytes | 500000000 |
.ESAPI.HttpUtilities.ResponseContentType | text/html, charset=UTF-8 |
.ESAPI.HttpUtilities.HttpSessionIdName | JSESSIONID |
ESAPI Intrusion
Property Name | Default Value |
---|
ESAPI.IntrusionDetector.Disable | true |
ESAPI.IntrusionDetector | org.owasp.esapi.reference.DefaultIntrusionDetector |
ESAPI.IntrusionDetector.event.test.actions | disable |
ESAPI.IntrusionDetector.event.test.count | 2 |
ESAPI.IntrusionDetector.event.test.interval | 10 |
ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.actions | log,disable,logout |
ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.count | 10 |
ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.interval | 5 |
ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.actions | log,disable,logout |
ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.count | 1 |
ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.interval | 1 |
ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.count | 2 |
ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.interval | 10 |
ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.actions | log,logout |
ESAPI Logger
Property Name | Default Value |
---|
.ESAPI.Logger | org.owasp.esapi.reference.Log4JLogFactory |
.ESAPI.Logger.ApplicationName | Resolve |
.ESAPI.Logger.LogApplicationName | true |
.ESAPI.Logger.LogEncodingRequired | false |
.ESAPI.Logger.LogFileName | ESAPI_logging_file |
.ESAPI.Logger.MaxLogFileSize | 10000000 |
.ESAPI.Logger.LogServerIP | true |
ESAPI Printproperty
Property Name | Default Value |
---|
ESAPI.printProperties | true |
Randomizer
Property Name | Default Value |
---|
ESAPI.Randomizer | org.owasp.esapi.reference.DefaultRandomizer |
ESAPI Validator
Property Name | Default Value |
---|
.ESAPI.Validator | org.owasp.esapi.reference.DefaultValidator |
.ESAPI.Validator.AcceptLenientDates | false |
.ESAPI.Validator.AccountName | ^[a-zA-Z0-9]{3,20}$ |
.ESAPI.Validator.ConfigurationFile | validation.properties |
.ESAPI.Validator.DirectoryName | ^.*$ |
.ESAPI.Validator.FileName | ^.*$ |
.ESAPI.Validator.HTTPContextPath | ^\/?[a-zA-Z0-9.\-\/_]*$ |
.ESAPI.Validator.HTTPCookieName | ^[a-zA-Z0-9\-_]{1,32}$ |
.ESAPI.Validator.HTTPCookieValue | a-zA-Z0-9\-\/+=_\.: \\@]*$ |
.ESAPI.Validator.HTTPHeaderName | ^.*$ |
.ESAPI.Validator.HTTPHeaderValue | ^.*$ |
.ESAPI.Validator.HTTPJSESSIONID | ^[A-Z0-9]{10,30}$ |
.ESAPI.Validator.HTTPParameterName | ^[a-zA-Z0-9_]{1,32}$ |
.ESAPI.Validator.HTTPParameterValue | ^[a-zA-Z0-9.\-\/+=@_ \\]*$ |
.ESAPI.Validator.HTTPPath | ^[a-zA-Z0-9.\-_]*$ |
.ESAPI.Validator.HTTPQueryString | ^[a-zA-Z0-9()\-=\*\.\?;,+\/:&_ %\\@]*$ |
.ESAPI.Validator.HTTPServletPath | ^[a-zA-Z0-9.\-\/_]*$ |
.ESAPI.Validator.HTTPScheme | ^(http |
.ESAPI.Validator.HTTPServerName | ^[a-zA-Z0-9_.\-]*$ |
.ESAPI.Validator.HTTPURI | ^.*$ |
.ESAPI.Validator.HTTPURL | ^.*$ |
.ESAPI.Validator.Redirect | ^.*$ |
.ESAPI.Validator.RoleName | ^[a-z]{1,20}$ |
.ESAPI.Validator.SystemCommand | ^[a-zA-Z\-\/]{1,64}$ |
ESAPI Authentification
Property Name | Default Value |
---|
rsconsole.ESAPI.Authenticator | Class used for ESAPI authenticator. |
rsconsole.ESAPI.Authenticator.AllowedLoginAttempts | Maximum allowed login attempt. |
rsconsole.ESAPI.Authenticator.MaxOldPasswordHashes | Maximum amount of old password hashes allowed. |
rsconsole.ESAPI.Authenticator.UsernameParameterName | Parameter name for the username in the ESAPI authenticator. |
rsconsole.ESAPI.Authenticator.PasswordParameterName | Parameter name for the password in the ESAPI authenticator. |
rsconsole.ESAPI.Authenticator.RememberTokenDuration | Period of time to remember an authentication token. |
rsconsole.ESAPI.Authenticator.IdleTimeoutDuration | Period of time a user can be idle before timeout. |
rsconsole.ESAPI.Authenticator.AbsoluteTimeoutDuration | Period of time until a token is times out. |
RSConsole ESAPI
Property Name | Default Value |
---|
rsconsole.ESAPI.Encryptor.PreferredJCEProvider | Preferred JCEProvider |
RSConsole ESAPI
Property Name | Default Value |
---|
rsconsole.ESAPI.AccessControl | Class used for access control |
RSConsole ESAPI Encryptor
Property Name | Default Value |
---|
rsconsole.ESAPI.Encryptor.EncryptionAlgorithm | Encryption algorithmn used. |
rsconsole.ESAPI.Encryptor.CipherTransformation | Cipher transformation used to encrypt. |
rsconsole.ESAPI.Encryptor.cipher_modes.combined_modes | Modes that support confidentiality and authenticity. |
rsconsole.ESAPI.Encryptor.cipher_modes.additional_allowed | Ciphers allowed in addition to the ones in combined_modes. |
rsconsole.ESAPI.Encryptor.EncryptionKeyLength | The number of bits in a key used by a cryptographic algorithm. |
rsconsole.ESAPI.Encryptor | Class used for encryption. |
rsconsole.ESAPI.Encryptor.ChooseIVMethod | Method of generating initialization vector. |
rsconsole.ESAPI.Encryptor.fixedIV | Iinitialization vector to use if fixed IV method is chosen. |
rsconsole.ESAPI.Encryptor.CipherText.useMAC | If 'true' compute and store the MAC. |
rsconsole.ESAPI.Encryptor.PlainText.overwrite | First overwrite the bytes of plaintext with the character. |
rsconsole.ESAPI.Encryptor.HashAlgorithm | Algorithm used to generate the encryption hash. |
rsconsole.ESAPI.Encryptor.HashIterations | Number of steps to take when hashing. |
rsconsole.ESAPI.Encryptor.DigitalSignatureAlgorithm | Algorithm used to generate a digital signature. |
rsconsole.ESAPI.Encryptor.DigitalSignatureKeyLength | The number of bits in a key used by a cryptographic algorithm. |
rsconsole.ESAPI.Encryptor.RandomAlgorithm | Algorithm used to generate a random number. |
rsconsole.ESAPI.Encryptor.CharacterEncoding | Character encoding used. |
rsconsole.ESAPI.Encryptor.KDF.PRF | Pseudo random function used in KDF. |
RSConsole ESAPI Executor
Property Name | Default Value |
---|
rsconsole.ESAPI.Executor | Class used to execute os commands. |
rsconsole.ESAPI.Executor.WorkingDirectory | Directory in which commands are executed. |
rsconsole.ESAPI.Executor.ApprovedExecutables | List of approved executable files. |
RSConsole ESAPI HTTPutilities
Property Name | Default Value |
---|
rsconsole.ESAPI.HTTPUtilities | Class used for securing http requests,responses,sessions, cookies, headers, and logging. |
rsconsole.ESAPI.HttpUtilities.UploadDir | Directory where files are uploaded. |
rsconsole.ESAPI.HttpUtilities.UploadTempDir | Directory where temporary files are uploaded. |
rsconsole.ESAPI.HttpUtilities.ForceHttpOnlySession | Set to 'true' to force the http only flag be set on the session. |
rsconsole.ESAPI.HttpUtilities.ForceSecureSession | Set to 'true' to force the secure session only flag to be set the session. |
rsconsole.ESAPI.HttpUtilities.ForceHttpOnlyCookies | Set to 'true' to force the http only flag to be set on cookies. |
rsconsole.ESAPI.HttpUtilities.ForceSecureCookies | Set to 'true' to force the secure only flag to be set on cookies. |
rsconsole.ESAPI.HttpUtilities.MaxHeaderSize | Maximum size of header. |
rsconsole.ESAPI.HttpUtilities.ApprovedUploadExtensions | Extensions allowed for upload. |
rsconsole.ESAPI.HttpUtilities.MaxUploadFileBytes | Maximum upload size for a file in bytes. |
rsconsole.ESAPI.HttpUtilities.ResponseContentType | The content type of the response and it's character encoding. |
rsconsole.ESAPI.HttpUtilities.HttpSessionIdName | The name of the http session. |
RSConsole ESAPI Intrusion Detector
Property Name | Default Value |
---|
rsconsole.ESAPI.IntrusionDetector.Disable | Set to 'true' to disable intrusion detection. |
rsconsole.ESAPI.IntrusionDetector | Class used for intrusion detection. |
rsconsole.ESAPI.IntrusionDetector.event.test.actions | Action to take if an intrusionexception fires. |
rsconsole.ESAPI.IntrusionDetector.event.test.count | Fire off intrusion exception if count events are received within an interval. |
rsconsole.ESAPI.IntrusionDetector.event.test.interval | Interval in which count actions are allowed. |
rsconsole.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.actions | Action to take if an integrityException fires. |
rsconsole.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.count | Fire off IntegrityException if count events are received within an interval. |
rsconsole.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.interval | Interval in which count actions are allowed. |
rsconsole.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.actions | Action to take if an IntrusionException fires. |
rsconsole.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.count | Fire off intrusion exception if count events are received within an interval. |
rsconsole.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.interval | Interval in which count actions are allowed. |
rsconsole.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.count | Fire off AuthenticationHostException if count events are received within an interval. |
rsconsole.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.interval | Interval in which count actions are allowed. |
rsconsole.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.actions | Action to take if an AuthenticationHostException fires. |
rsconsole.ESAPI.Logger | Logger factory used to create a logger. |
rsconsole.ESAPI.Logger.ApplicationName | Name of the application being logged for. |
rsconsole.ESAPI.Logger.LogApplicationName | Determines whether ESAPI should log the application name |
rsconsole.ESAPI.Logger.LogEncodingRequired | Set to true to require log data to be encoded. |
rsconsole.ESAPI.Logger.LogFileName | Name of file to log into |
rsconsole.ESAPI.Logger.MaxLogFileSize | Max log file size. |
rsconsole.ESAPI.Logger.LogServerIP | Log the server ip when logging. |
RSConsole ESAPI print Properties
Property Name | Default Value |
---|
rsconsole.ESAPI.printProperties | If 'true' print all ESAPI properties when loaded |
RSConsole ESAPI Randomizer
Property Name | Default Value |
---|
rsconsole.ESAPI.Randomizer | Class used for creating random numbers |
RSConsole ESAPI Validator
Property Name | Default Value |
---|
rsconsole.ESAPI.Validator | Class used for validation. |
rsconsole.ESAPI.Validator.AcceptLenientDates | Set to 'true' to accept lenient dates. |
rsconsole.ESAPI.Validator.AccountName | regex for allowed characters and length for an account name |
rsconsole.ESAPI.Validator.ConfigurationFile | Name of the config file for validation. |
rsconsole.ESAPI.Validator.DirectoryName | regex for a valid directory name |
rsconsole.ESAPI.Validator.FileName | regex for a valid file name |
rsconsole.ESAPI.Validator.HTTPContextPath | regex for a valid http context path |
rsconsole.ESAPI.Validator.HTTPCookieName | regex for a valid cookie name |
rsconsole.ESAPI.Validator.HTTPCookieValue | regex for a valid cookie value |
rsconsole.ESAPI.Validator.HTTPHeaderName | regex for a valid http header name |
rsconsole.ESAPI.Validator.HTTPHeaderValue | regex for a valid http header value |
rsconsole.ESAPI.Validator.HTTPJSESSIONID | regex for a valid http JSESSIONID |
rsconsole.ESAPI.Validator.HTTPParameterName | regex for a valid http parameter name |
rsconsole.ESAPI.Validator.HTTPParameterValue | regex for a valid http parameter value |
rsconsole.ESAPI.Validator.HTTPPath | regex for a valid http path. |
rsconsole.ESAPI.Validator.HTTPQueryString | regex for a valid http query string |
rsconsole.ESAPI.Validator.HTTPServletPath | regex for a valid http servlet path |
rsconsole.ESAPI.Validator.HTTPScheme | regex for a valid http scheme |
rsconsole.ESAPI.Validator.HTTPServerName | regex for a valid http server name |
rsconsole.ESAPI.Validator.HTTPURI | regex for a valid http uri |
rsconsole.ESAPI.Validator.HTTPURL | regex for a valid http url |
rsconsole.ESAPI.Validator.Redirect | regex for a valid redirect |
rsconsole.ESAPI.Validator.RoleName | regex for a valid rolename |
rsconsole.ESAPI.Validator.SystemCommand | regex for a valid System Command |
RSControl ESAPI AccesControl
Property Name | Default Value |
---|
rscontrol.ESAPI.AccessControl | Class used for access control. |
RSControl ESAPI Authentication
Property Name | Default Value |
---|
rscontrol.ESAPI.Authenticator | Class used for ESAPI authenticator. |
rscontrol.ESAPI.Authenticator.AllowedLoginAttempts | Maximum allowed login attemps. |
rscontrol.ESAPI.Authenticator.MaxOldPasswordHashes | Maximum amount of old password hashes allowed. |
rscontrol.ESAPI.Authenticator.UsernameParameterName | Parameter name for the username in the ESAPI authenticator |
rscontrol.ESAPI.Authenticator.PasswordParameterName | Parameter name for the password in the ESAPI authenticator. |
rscontrol.ESAPI.Authenticator.RememberTokenDuration | Period of time to remember an authentication token. |
rscontrol.ESAPI.Authenticator.IdleTimeoutDuration | Period of time a user can be idle before timeout. |
rscontrol.ESAPI.Authenticator.AbsoluteTimeoutDuration | Period of time until a token is times out. |
RSControl ESAPI Encoder
Property Name | Default Value |
---|
rscontrol.ESAPI.Encoder | Class used for encoding. |
rscontrol.ESAPI.Encoder.AllowMultipleEncoding | Set to 'true' to allow multiple encoding. |
rscontrol.ESAPI.Encoder.DefaultCodecList | List of encoders used by default. |
rscontrol.ESAPI.Encryptor.PreferredJCEProvider | Preferred JCEProvider. |
rscontrol.ESAPI.Encryptor.EncryptionAlgorithm | Encryption algorithmn used. |
rscontrol.ESAPI.Encryptor.CipherTransformation | Cipher transformation used to encrypt. |
rscontrol.ESAPI.Encryptor.cipher_modes.combined_modes | Modes that support confidentiality and authenticity. |
rscontrol.ESAPI.Encryptor.cipher_modes.additional_allowed | Ciphers allowed in addition to the ones in combined_modes. |
rscontrol.ESAPI.Encryptor.EncryptionKeyLength | The number of bits in a key used by a cryptographic algorithm. |
rscontrol.ESAPI.Encryptor | Class used for encryption. |
rscontrol.ESAPI.Encryptor.ChooseIVMethod | Method of generating initialization vector. |
rscontrol.ESAPI.Encryptor.fixedIV | Initialization vector to use if fixed IV method is chosen. |
rscontrol.ESAPI.Encryptor.CipherText.useMAC | If 'true' compute and store the MAC |
rscontrol.ESAPI.Encryptor.PlainText.overwrite | First overwrite teh bytes of plaintext with the character |
rscontrol.ESAPI.Encryptor.HashAlgorithm | Algorithm used to generate the encryption hash. |
rscontrol.ESAPI.Encryptor.HashIterations | Number of steps to take when hashing. |
rscontrol.ESAPI.Encryptor.DigitalSignatureAlgorithm | Algorithm used to generate a digital signature. |
rscontrol.ESAPI.Encryptor.DigitalSignatureKeyLength | The number of bits in a key used by a cryptographic algorithm. |
rscontrol.ESAPI.Encryptor.RandomAlgorithm | Algorithm used to generate a random number. |
rscontrol.ESAPI.Encryptor.CharacterEncoding | Character encoding used. |
rscontrol.ESAPI.Encryptor.KDF.PRF | Pseudo random function used in KDF. |
RSControl ESAPI Executor
Property Name | Default Value |
---|
rscontrol.ESAPI.Executor | Class used to execute os commands. |
rscontrol.ESAPI.Executor.WorkingDirectory | Directory in which commands are executed. |
rscontrol.ESAPI.Executor.ApprovedExecutables | List of approved executable files. |
RSControl ESAPI HTTUtilties
Property Name | Default Value |
---|
rscontrol.ESAPI.HTTPUtilities | Class used for securing http requests,responses,sessions, cookies, headers, and logging. |
rscontrol.ESAPI.HttpUtilities.UploadDir | Directory for files upload. |
rscontrol.ESAPI.HttpUtilities.UploadTempDir | Directory for temporary files upload. |
rscontrol.ESAPI.HttpUtilities.ForceHttpOnlySession | Set to 'true' to force the http only flag be set on the session. |
rscontrol.ESAPI.HttpUtilities.ForceSecureSession | Set to 'true' to force the secure session only flag to be set the session. |
rscontrol.ESAPI.HttpUtilities.ForceHttpOnlyCookies | Set to 'true' to force the http only flag to be set on cookies. |
rscontrol.ESAPI.HttpUtilities.ForceSecureCookies | Set to 'true' to force the secure only flag to be set on cookies. |
rscontrol.ESAPI.HttpUtilities.MaxHeaderSize | Maximum size of header. |
rscontrol.ESAPI.HttpUtilities.ApprovedUploadExtensions | Extensions allowed for upload. |
rscontrol.ESAPI.HttpUtilities.MaxUploadFileBytes | Maximum upload size for a file in bytes. |
rscontrol.ESAPI.HttpUtilities.ResponseContentType | The content type of the response and its character encoding. |
rscontrol.ESAPI.HttpUtilities.HttpSessionIdName | Name of the http session. |
RSControl ESAPI Intrsuin Detector
Property Name | Default Value |
---|
rscontrol.ESAPI.IntrusionDetector.Disable | Set to 'true' to disable intrusion detection. |
rscontrol.ESAPI.IntrusionDetector | Class used for intrusion detection. |
rscontrol.ESAPI.IntrusionDetector.event.test.actions | Action to take if an intrusionexception fires. |
rscontrol.ESAPI.IntrusionDetector.event.test.count | Fire off intrusion exception if count events are received within an interval. |
rscontrol.ESAPI.IntrusionDetector.event.test.interval | Interval in which count actions are allowed. |
rscontrol.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.actions | Action to take if an integrityException fires. |
rscontrol.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.count | Fire off IntegrityException if count events are received within an interval. |
rscontrol.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.interval | Interval in which count actions are allowed. |
rscontrol.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.actions | Action to take if an IntrusionException fires. |
rscontrol.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.count | Fire off intrusion exception if count events are received within an interval. |
rscontrol.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.interval | Interval in which count actions are allowed. |
rscontrol.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.count | Fire off AuthenticationHostException if count events are received within an interval. |
rscontrol.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.interval | Interval in which count actions are allowed. |
rscontrol.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.actions | Action to take if an AuthenticationHostException fires. |
RSControl ESAPI Logger
Property Name | Default Value |
---|
rscontrol.ESAPI.Logger | Logger factory used to create a logger. |
rscontrol.ESAPI.Logger.ApplicationName | Name of the application being logged for. |
rscontrol.ESAPI.Logger.LogApplicationName | Determines whether ESAPI should log the application name. |
rscontrol.ESAPI.Logger.LogEncodingRequired | Set to 'true' to require log data to be encoded. |
rscontrol.ESAPI.Logger.LogFileName | Name of file to log into. |
rscontrol.ESAPI.Logger.MaxLogFileSize | Max log file size. |
rscontrol.ESAPI.Logger.LogServerIP | Log the server ip when logging. |
RSControl ESAPI Encryptor
Property Name | Default Value |
---|
rscontrol.ESAPI.printProperties | If 'true' print all ESAPI properties when loaded. |
RSControl ESAPI Randomizer
Property Name | Default Value |
---|
rscontrol.ESAPI.Randomizer | Class used for creating random numbers. |
RSmgmt ESAPI AccessControl
Property Name | Default Value |
---|
rsmgmt.ESAPI.AccessControl | Class used for access control. |
RSmgmt ESAPI Authentification
Property Name | Default Value |
---|
rsmgmt.ESAPI.Authenticator | Class used for ESAPI authenticator. |
rsmgmt.ESAPI.Authenticator.AllowedLoginAttempts | Maximum allowed login attemps. |
rsmgmt.ESAPI.Authenticator.MaxOldPasswordHashes | Maximum amount of old password hashes allowed. |
rsmgmt.ESAPI.Authenticator.UsernameParameterName | Parameter name for the username in the ESAPI authenticator. |
rsmgmt.ESAPI.Authenticator.PasswordParameterName | Parameter name for the password in the ESAPI authenticator. |
rsmgmt.ESAPI.Authenticator.RememberTokenDuration | Period of time to remember an authentication token. |
rsmgmt.ESAPI.Authenticator.IdleTimeoutDuration | Period of time a user can be idle before time out. |
rsmgmt.ESAPI.Authenticator.AbsoluteTimeoutDuration | Period of time until a token times out |
RSmgmt ESAPI Encoder
Property Name | Default Value |
---|
rsmgmt.ESAPI.Encoder | Class used for encoding. |
rsmgmt.ESAPI.Encoder.AllowMultipleEncoding | Set to 'true' to allow multiple encoding. |
rsmgmt.ESAPI.Encoder.DefaultCodecList | List of encoders used by default. |
RSmgmt ESAPI Encryptor
Property Name | Default Value |
---|
rsmgmt.ESAPI.Encryptor.PreferredJCEProvider | Preferred JCEProvider. |
rsmgmt.ESAPI.Encryptor.EncryptionAlgorithm | Encryption algorithmn used. |
rsmgmt.ESAPI.Encryptor.CipherTransformation | Cipher transformation used to encrypt. |
rsmgmt.ESAPI.Encryptor.cipher_modes.combined_modes | Modes that support confidentiality and authenticity. |
rsmgmt.ESAPI.Encryptor.cipher_modes.additional_allowed | Ciphers allowed in addition to the ones in combined_modes. |
rsmgmt.ESAPI.Encryptor.EncryptionKeyLength | The number of bits in a key used by a cryptographic algorithm. |
rsmgmt.ESAPI.Encryptor | Class used for encryption. |
rsmgmt.ESAPI.Encryptor.ChooseIVMethod | Method of generating initialization vector. |
rsmgmt.ESAPI.Encryptor.fixedIV | Initialization vector to use if fixed IV method is chosen. |
rsmgmt.ESAPI.Encryptor.CipherText.useMAC | If 'true' compute and store the MAC. |
rsmgmt.ESAPI.Encryptor.PlainText.overwrite | First overwrite the bytes of plaintext with the character. |
rsmgmt.ESAPI.Encryptor.HashAlgorithm | Algorithm used to generate the encryption hash. |
rsmgmt.ESAPI.Encryptor.HashIterations | Number of steps to take when hashing. |
rsmgmt.ESAPI.Encryptor.DigitalSignatureAlgorithm | Algorithm used to generate a digital signature. |
rsmgmt.ESAPI.Encryptor.DigitalSignatureKeyLength | The number of bits in a key used by a cryptographic algorithm. |
rsmgmt.ESAPI.Encryptor.RandomAlgorithm | Algorithm used to generate a random number. |
rsmgmt.ESAPI.Encryptor.CharacterEncoding | Character encoding used. |
rsmgmt.ESAPI.Encryptor.KDF.PRF | Psuedo random function used in KDF. |
RSmgmt ESAPI Executor
Property Name | Default Value |
---|
rsmgmt.ESAPI.Executor | Class used to execute os commands. |
rsmgmt.ESAPI.Executor.WorkingDirectory | Directory in which commands are executed. |
rsmgmt.ESAPI.Executor.ApprovedExecutables | List of approved executable files. |
RSmgmt HTTPUtilities
Property Name | Default Value |
---|
rsmgmt.ESAPI.HTTPUtilities | Class used for securing http requests, responses, sessions, cookies, headers, and logging. |
rsmgmt.ESAPI.HttpUtilities.UploadDir | Directory for files upload. |
rsmgmt.ESAPI.HttpUtilities.UploadTempDir | Directory for temporary files upload. |
rsmgmt.ESAPI.HttpUtilities.ForceHttpOnlySession | Set to 'true' to force the http only flag be set on the session. |
rsmgmt.ESAPI.HttpUtilities.ForceSecureSession | Set to 'true' to force the secure session only flag to be set the session. |
rsmgmt.ESAPI.HttpUtilities.ForceHttpOnlyCookies | Set to 'true' to force the http only flag to be set on cookies. |
rsmgmt.ESAPI.HttpUtilities.ForceSecureCookies | Set to 'true' to force the secure only flag to be set on cookies. |
rsmgmt.ESAPI.HttpUtilities.MaxHeaderSize | Maximum size of header. |
rsmgmt.ESAPI.HttpUtilities.ApprovedUploadExtensions | Extensions allowed for upload. |
rsmgmt.ESAPI.HttpUtilities.MaxUploadFileBytes | Maximum upload size for a file in bytes. |
rsmgmt.ESAPI.HttpUtilities.ResponseContentType | The content type of the response and its character encoding. |
rsmgmt.ESAPI.HttpUtilities.HttpSessionIdName | Name of the http session. |
RSmgmt ESAPI Intrusion Detector
Property Name | Default Value |
---|
rsmgmt.ESAPI.IntrusionDetector.Disable | Set to 'true' to disable intrusion detection. |
rsmgmt.ESAPI.IntrusionDetector | Class used for intrusion detection. |
rsmgmt.ESAPI.IntrusionDetector.event.test.actions | Action to take if an intrusionexception fires. |
rsmgmt.ESAPI.IntrusionDetector.event.test.count | Fire off intrusion exception if count events are received within an interval. |
rsmgmt.ESAPI.IntrusionDetector.event.test.interval | Interval in which count actions are allowed. |
rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.actions | Action to take if an integrityException fires. |
rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.count | Fire off IntegrityException if count events are received within an interval. |
rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.interval | Interval in which count actions are allowed. |
rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.actions | Action to take if an IntrusionException fires. |
rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.count | Fire off intrusion exception if count events are received within an interval. |
rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.interval | Interval in which count actions are allowed. |
rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.count | Fire off AuthenticationHostException if count events are received within an interval. |
rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.interval | Interval in which count actions are allowed. |
rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.actions | Action to take if an AuthenticationHostException fires. |
RSmgmt ESAPI Logger
Property Name | Default Value |
---|
rsmgmt.ESAPI.Logger | Logger factory used to create a logger. |
rsmgmt.ESAPI.Logger.ApplicationName | Name of the application being logged for. |
rsmgmt.ESAPI.Logger.LogApplicationName | Determines whether ESAPI should log the application name. |
rsmgmt.ESAPI.Logger.LogEncodingRequired | Set to 'true' to require log data to be encoded. |
rsmgmt.ESAPI.Logger.LogFileName | Name of file to log into. |
rsmgmt.ESAPI.Logger.MaxLogFileSize | Max log file size. |
rsmgmt.ESAPI.Logger.LogServerIP | Log the server IP when logging. |
RSmgmt printProperteis
Property Name | Default Value |
---|
rsmgmt.ESAPI.printProperties | If 'true' print all ESAPI properties when loaded. |
RSmgmt ESAPI Randomizer
Property Name | Description | Default Value |
---|
rsmgmt.ESAPI.Randomizer | Class used for creating random numbers. | org.owasp.esapi.reference.DefaultRandomizer |
RSmgmt ESAPI Validation
Property Name | Default Value |
---|
rsmgmt.ESAPI.Validator | Class used for validation. |
rsmgmt.ESAPI.Validator.AcceptLenientDates | Set to 'true' to accept lenient dates. |
rsmgmt.ESAPI.Validator.AccountName | regex for allowed chracters and length for an account name |
rsmgmt.ESAPI.Validator.ConfigurationFile | Name of the config file for validation. |
rsmgmt.ESAPI.Validator.DirectoryName | regex for a valid directory name |
rsmgmt.ESAPI.Validator.FileName | regex for a valid file name |
rsmgmt.ESAPI.Validator.HTTPContextPath | regex for a valid http context path |
rsmgmt.ESAPI.Validator.HTTPCookieName | regex for a valid cookie name |
rsmgmt.ESAPI.Validator.HTTPCookieValue | regex for a valid cookie value |
rsmgmt.ESAPI.Validator.HTTPHeaderName | regex for a valid http header name |
rsmgmt.ESAPI.Validator.HTTPHeaderValue | regex for a valid http header value |
rsmgmt.ESAPI.Validator.HTTPJSESSIONID | regex for a valid http JSESSIONID |
rsmgmt.ESAPI.Validator.HTTPParameterName | regex for a valid http parameter name |
rsmgmt.ESAPI.Validator.HTTPParameterValue | regex for a valid http parameter value |
rsmgmt.ESAPI.Validator.HTTPPath | regex for a valid http path |
rsmgmt.ESAPI.Validator.HTTPQueryString | regex for a valid http query string |
rsmgmt.ESAPI.Validator.HTTPServletPath | regex for a valid http servlet path |
rsmgmt.ESAPI.Validator.HTTPScheme | regex for a valid http scheme |
rsmgmt.ESAPI.Validator.HTTPServerName | regex for a valid http server name |
rsmgmt.ESAPI.Validator.HTTPURI | regex for a valid http uri |
rsmgmt.ESAPI.Validator.HTTPURL | regex for a valid http url |
rsmgmt.ESAPI.Validator.Redirect | regex for a valid redirect |
rsmgmt.ESAPI.Validator.RoleName | regex for a valid rolename |
rsmgmt.ESAPI.Validator.SystemCommand | regex for a valid System Command |
RSproxy ESAPI Acces Control
Property Name | Default Value |
---|
rsproxy.ESAPI.AccessControl | Class used for access control. |
RSproxy ESAPI Authentication
Property Name | Default Value |
---|
rsproxy.ESAPI.Authenticator | Class used for ESAPI authenticator. |
rsproxy.ESAPI.Authenticator.AllowedLoginAttempts | Maximum allowed login attemps. |
rsproxy.ESAPI.Authenticator.MaxOldPasswordHashes | Maximum amount of old password hashes allowed. |
rsproxy.ESAPI.Authenticator.UsernameParameterName | Parameter name for the username in the ESAPI authenticator. |
rsproxy.ESAPI.Authenticator.PasswordParameterName | Parameter name for the password in the ESAPI authenticator. |
rsproxy.ESAPI.Authenticator.RememberTokenDuration | Period of time to remember an authentication token. |
rsproxy.ESAPI.Authenticator.IdleTimeoutDuration | Period of time a user can be idle before time out. |
rsproxy.ESAPI.Authenticator.AbsoluteTimeoutDuration | Period of time until a token times out. |
RSproxy ESAPI Encoder
Property Name | Default Value |
---|
rsproxy.ESAPI.Encoder | Class used for encoding. |
rsproxy.ESAPI.Encoder.AllowMultipleEncoding | Set to 'true' to allow multiple encoding. |
rsproxy.ESAPI.Encoder.DefaultCodecList | List of encoders used by default. |
RSproxy ESAPI Encryptor
Property Name | Default Value |
---|
rsproxy.ESAPI.Encryptor.PreferredJCEProvider | Preferred JCEProvider. |
rsproxy.ESAPI.Encryptor.EncryptionAlgorithm | Encryption algorithmn used. |
rsproxy.ESAPI.Encryptor.CipherTransformation | Cipher transformation used to encrypt. |
rsproxy.ESAPI.Encryptor.cipher_modes.combined_modes | Modes that support confidentiality and authenticity. |
rsproxy.ESAPI.Encryptor.cipher_modes.additional_allowed | Ciphers allowed in addition to the ones in combined_modes. |
rsproxy.ESAPI.Encryptor.EncryptionKeyLength | The number of bits in a key used by a cryptographic algorithm. |
rsproxy.ESAPI.Encryptor | Class used for encryption. |
rsproxy.ESAPI.Encryptor.ChooseIVMethod | Method of generating initialization vector. |
rsproxy.ESAPI.Encryptor.fixedIV | Initialization vector to use if fixed IV method is chosen. |
rsproxy.ESAPI.Encryptor.CipherText.useMAC | If 'true' compute and store the MAC. |
rsproxy.ESAPI.Encryptor.PlainText.overwrite | First overwrite the bytes of plaintext with the character. |
rsproxy.ESAPI.Encryptor.HashAlgorithm | Algorithm used to generate the encryption hash. |
rsproxy.ESAPI.Encryptor.HashIterations | Number of steps to take when hashing. |
rsproxy.ESAPI.Encryptor.DigitalSignatureAlgorithm | Algorithm used to generate a digital signature. |
rsproxy.ESAPI.Encryptor.DigitalSignatureKeyLength | The number of bits in a key used by. a cryptographic algorithm. |
rsproxy.ESAPI.Encryptor.RandomAlgorithm | Algorithm used to generate a random number. |
rsproxy.ESAPI.Encryptor.CharacterEncoding | Character encoding used. |
rsproxy.ESAPI.Encryptor.KDF.PRF | Psuedo random function used in KDF. |
RSproxy ESAPI Executor
Property Name | Default Value |
---|
rsproxy.ESAPI.Executor | Class used to execute os commands. |
rsproxy.ESAPI.Executor.WorkingDirectory | Directory in which commands are executed. |
rsproxy.ESAPI.Executor.ApprovedExecutables | List of approved executable files. |
RSproxy ESAPI HTTPUtilities
Property Name | Default Value |
---|
rsproxy.ESAPI.HTTPUtilities | Class used for securing http requests,responses,sessions, cookies, headers, and logging. |
rsproxy.ESAPI.HttpUtilities.UploadDir | Directory for files upload. |
rsproxy.ESAPI.HttpUtilities.UploadTempDir | Directory for temporary files upload. |
rsproxy.ESAPI.HttpUtilities.ForceHttpOnlySession | Set to 'true' to force the http only flag be set on the session. |
rsproxy.ESAPI.HttpUtilities.ForceSecureSession | Set to 'true' to force the secure session only flag to be set the session. |
rsproxy.ESAPI.HttpUtilities.ForceHttpOnlyCookies | Set to 'true' to force the http only flag to be set on cookies. |
rsproxy.ESAPI.HttpUtilities.ForceSecureCookies | Set to 'true' to force the secure only flag to be set on cookies. |
rsproxy.ESAPI.HttpUtilities.MaxHeaderSize | Maximum size of header. |
rsproxy.ESAPI.HttpUtilities.ApprovedUploadExtensions | Extensions allowed for upload. |
rsproxy.ESAPI.HttpUtilities.MaxUploadFileBytes | Maximum upload size for a file in bytes. |
rsproxy.ESAPI.HttpUtilities.ResponseContentType | The content type of the response and its character encoding. |
rsproxy.ESAPI.HttpUtilities.HttpSessionIdName | Name of the http session. |
RSproxy ESAPI Intrusion Detector
Property Name | Default Value |
---|
rsproxy.ESAPI.IntrusionDetector.Disable | Set to 'true' to disable intrusion detection. |
rsproxy.ESAPI.IntrusionDetector | Class used for intrusion detection. |
rsproxy.ESAPI.IntrusionDetector.event.test.actions | Action to take if an intrusionexception fires. |
rsproxy.ESAPI.IntrusionDetector.event.test.count | Fire off intrusion exception if count events are received within an interval. |
rsproxy.ESAPI.IntrusionDetector.event.test.interval | Interval in which count actions are allowed. |
rsproxy.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.actions | Action to take if an integrityException fires. |
rsproxy.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.count | Fire off IntegrityException if count events are received within an interval. |
rsproxy.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.interval | Interval in which count actions are allowed. |
rsproxy.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.actions | Action to take if an IntrusionException fires. |
rsproxy.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.count | Fire off intrusion exception if count events are received within an interval. |
rsproxy.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.interval | Interval in which count actions are allowed. |
rsproxy.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.count | Fire off AuthenticationHostException if count events are received within an interval. |
rsproxy.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.interval | Interval in which count actions are allowed. |
rsproxy.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.actions | Action to take if an AuthenticationHostException fires. |
RSproxy ESAPI Logger
Property Name | Default Value |
---|
rsproxy.ESAPI.Logger | Logger factory used to create a logger. |
rsproxy.ESAPI.Logger.ApplicationName | Name of the application being logged for. |
rsproxy.ESAPI.Logger.LogApplicationName | Determines whether ESAPI should log the application name. |
rsproxy.ESAPI.Logger.LogEncodingRequired | Set to 'true' to require log data to be encoded. |
rsproxy.ESAPI.Logger.LogFileName | Name of file to log into. |
rsproxy.ESAPI.Logger.MaxLogFileSize | Max log file size. |
rsproxy.ESAPI.Logger.LogServerIP | Log the server ip when logging. |
RSproxy ESAPI printProperties
Property Name | Default Value |
---|
rsproxy.ESAPI.printProperties | If 'true' print all ESAPI properties when loaded. |
RSproxy ESAPI Randomizer
Property Name | Default Value |
---|
rsproxy.ESAPI.Randomizer | Class used for creating random numbers. |
RSproxy ESAPI
Property Name | Default Value |
---|
rsproxy.ESAPI.Validator | Class used for validation. |
rsproxy.ESAPI.Validator.AcceptLenientDates | Set to 'true' to accept lenient dates. |
rsproxy.ESAPI.Validator.AccountName | regex for allowed chracters and length for an account name |
rsproxy.ESAPI.Validator.ConfigurationFile | Name of the config file for validation. |
rsproxy.ESAPI.Validator.DirectoryName | regex for a valid directory name |
rsproxy.ESAPI.Validator.FileName | regex for a valid file name |
rsproxy.ESAPI.Validator.HTTPContextPath | regex for a valid http context path |
rsproxy.ESAPI.Validator.HTTPCookieName | regex for a valid cookie name |
rsproxy.ESAPI.Validator.HTTPCookieValue | regex for a valid cookie value |
rsproxy.ESAPI.Validator.HTTPHeaderName | regex for a valid http header name |
rsproxy.ESAPI.Validator.HTTPHeaderValue | regex for a valid http header value |
rsproxy.ESAPI.Validator.HTTPJSESSIONID | regex for a valid http JSESSIONID |
rsproxy.ESAPI.Validator.HTTPParameterName | regex for a valid http parameter name |
rsproxy.ESAPI.Validator.HTTPParameterValue | regex for a valid http parameter value |
rsproxy.ESAPI.Validator.HTTPPath | regex for a valid http path |
rsproxy.ESAPI.Validator.HTTPQueryString | regex for a valid http query string |
rsproxy.ESAPI.Validator.HTTPServletPath | regex for a valid http servlet path |
rsproxy.ESAPI.Validator.HTTPScheme | regex for a valid http scheme |
rsproxy.ESAPI.Validator.HTTPServerName | regex for a valid http server name |
rsproxy.ESAPI.Validator.HTTPURI | regex for a valid http uri |
rsproxy.ESAPI.Validator.HTTPURL | regex for a valid http url |
rsproxy.ESAPI.Validator.Redirect | regex for a valid redirect |
rsproxy.ESAPI.Validator.RoleName | regex for a valid rolename |
rsproxy.ESAPI.Validator.SystemCommand | regex for a valid System Command |
RSremote ESAPI Access Control
Property Name | Default Value |
---|
rsremote.ESAPI.AccessControl | Class used for access control. |
RSremote ESAPI Authentification
Property Name | Default Value |
---|
rsremote.ESAPI.Authenticator | Class used for ESAPI authenticator. |
rsremote.ESAPI.Authenticator.AllowedLoginAttempts | Maximum allowed login attemps. |
rsremote.ESAPI.Authenticator.MaxOldPasswordHashes | Maximum amount of old password hashes allowed. |
rsremote.ESAPI.Authenticator.UsernameParameterName | Parameter name for the username in the ESAPI authenticator. |
rsremote.ESAPI.Authenticator.PasswordParameterName | Parameter name for the password in the ESAPI authenticator. |
rsremote.ESAPI.Authenticator.RememberTokenDuration | Period of time to remember an authentication token. |
rsremote.ESAPI.Authenticator.IdleTimeoutDuration | Period of time a user can be idle before time out. |
rsremote.ESAPI.Authenticator.AbsoluteTimeoutDuration | Period of time until a token is times out. |
RSremote ESAPI Authentification
Property Name | Default Value |
---|
rsremote.ESAPI.Encoder | Class used for encoding. |
rsremote.ESAPI.Encoder.AllowMultipleEncoding | Set to 'true' to allow multiple encoding. |
rsremote.ESAPI.Encoder.DefaultCodecList | List of encoders used by default. |
RSremote ESAPI Encryptor
Property Name | Default Value |
---|
rsremote.ESAPI.Encryptor.PreferredJCEProvider | Preferred JCEProvider. |
rsremote.ESAPI.Encryptor.EncryptionAlgorithm | Encryption algorithmn used. |
rsremote.ESAPI.Encryptor.CipherTransformation | Cipher transformation used to encrypt. |
rsremote.ESAPI.Encryptor.cipher_modes.combined_modes | Modes that support confidentiality and authenticity. |
rsremote.ESAPI.Encryptor.cipher_modes.additional_allowed | Ciphers allowed in addition to the ones in combined_modes. |
rsremote.ESAPI.Encryptor.EncryptionKeyLength | The number of bits in a key used by a cryptographic algorithm. |
rsremote.ESAPI.Encryptor | Class used for encryption. |
rsremote.ESAPI.Encryptor.ChooseIVMethod | Method of generating initialization vector. |
rsremote.ESAPI.Encryptor.fixedIV | Initialization vector to use if fixed IV method is chosen. |
rsremote.ESAPI.Encryptor.CipherText.useMAC | If 'true' compute and store the MAC. |
rsremote.ESAPI.Encryptor.PlainText.overwrite | First overwrite the bytes of plaintext with the character. |
rsremote.ESAPI.Encryptor.HashAlgorithm | Algorithm used to generate the encryption hash. |
rsremote.ESAPI.Encryptor.HashIterations | Number of steps to take when hashing. |
rsremote.ESAPI.Encryptor.DigitalSignatureAlgorithm | Algorithm used to generate a digital signature. |
rsremote.ESAPI.Encryptor.DigitalSignatureKeyLength | The number of bits in a key used by a cryptographic algorithm. |
rsremote.ESAPI.Encryptor.RandomAlgorithm | Algorithm used to generate a random number. |
rsremote.ESAPI.Encryptor.CharacterEncoding | Character encoding used. |
rsremote.ESAPI.Encryptor.KDF.PRF | Psuedo random function used in KDF. |
RSproxy ESAPI Executor
Property Name | Default Value |
---|
rsremote.ESAPI.Executor | Class used to execute os commands. |
rsremote.ESAPI.Executor.WorkingDirectory | Directory in which commands are executed |
rsremote.ESAPI.Executor.ApprovedExecutables | List of approved executable files. |
RSproxy ESAPI
Property Name | Default Value |
---|
rsremote.ESAPI.HTTPUtilities | Class used for securing http requests, responses, sessions, cookies, headers, and logging. |
rsremote.ESAPI.HttpUtilities.UploadDir | Directory for files upload. |
rsremote.ESAPI.HttpUtilities.UploadTempDir | Directory for temporary files upload. |
rsremote.ESAPI.HttpUtilities.ForceHttpOnlySession | Set to 'true' to force the http only flag be set on the session. |
rsremote.ESAPI.HttpUtilities.ForceSecureSession | Set to 'true' to force the secure session only flag to be set the session. |
rsremote.ESAPI.HttpUtilities.ForceHttpOnlyCookies | Set to 'true' to force the http only flag to be set on cookies. |
rsremote.ESAPI.HttpUtilities.ForceSecureCookies | Set to 'true' to force the secure only flag to be set on cookies. |
rsremote.ESAPI.HttpUtilities.MaxHeaderSize | Maximum size of header. |
rsremote.ESAPI.HttpUtilities.ApprovedUploadExtensions | Extensions allowed for upload. |
rsremote.ESAPI.HttpUtilities.MaxUploadFileBytes | Maximum upload size for a file in bytes. |
rsremote.ESAPI.HttpUtilities.ResponseContentType | The content type of the response and its character encoding. |
rsremote.ESAPI.HttpUtilities.HttpSessionIdName | Name of the http session. |
RSproxy ESAPI Intrusion
Property Name | Default Value |
---|
rsremote.ESAPI.IntrusionDetector.Disable | Set to 'true' to disable intrusion detection. |
rsremote.ESAPI.IntrusionDetector | Class used for intrusion detection. |
rsremote.ESAPI.IntrusionDetector.event.test.actions | Action to take if an intrusionexception fires. |
rsremote.ESAPI.IntrusionDetector.event.test.count | Fire off intrusion exception if count events are received within an interval. |
rsremote.ESAPI.IntrusionDetector.event.test.interval | Interval in which count actions are allowed. |
rsremote.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.actions | Action to take if an integrityException fires. |
rsremote.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.count | Fire off IntegrityException if count events are received within an interval. |
rsremote.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.interval | Interval in which count actions are allowed. |
rsremote.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.actions | Action to take if an IntrusionException fires. |
rsremote.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.count | Fire off intrusion exception if count events are received within an interval. |
rsremote.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.interval | Interval in which count actions are allowed. |
rsremote.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.count | Fire off AuthenticationHostException if count events are received within an interval. |
rsremote.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.interval | Interval in which count actions are allowed. |
rsremote.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.actions | Action to take if an AuthenticationHostException fires. |
rsremote.ESAPI.Logger | Logger factory used to create a logger. |
rsremote.ESAPI.Logger.ApplicationName | Name of the application being logged for. |
rsremote.ESAPI.Logger.LogApplicationName | Determines whether ESAPI should log the application name. |
rsremote.ESAPI.Logger.LogEncodingRequired | Set to 'true' to require log data to be encoded. |
rsremote.ESAPI.Logger.LogFileName | Name of file to log into. |
rsremote.ESAPI.Logger.MaxLogFileSize | Max log file size. |
rsremote.ESAPI.Logger.LogServerIP | Log the server ip when logging. |
RSproxy ESAPI printProperties
Property Name | Default Value |
---|
rsremote.ESAPI.printProperties | If 'true' print all ESAPI properties when loaded. |
RSproxy ESAPI Randomizer
Property Name | Default Value |
---|
rsremote.ESAPI.Randomizer | Class used for creating random numbers |
RSproxy ESAPI Validators
Property Name | Default Value |
---|
rsremote.ESAPI.Validator | Class used for validation. |
rsremote.ESAPI.Validator.AcceptLenientDates | Set to 'true' to accept lenient dates. |
rsremote.ESAPI.Validator.AccountName | regex for allowed chracters and length for an account name |
rsremote.ESAPI.Validator.ConfigurationFile | Name of the config file for validation. |
rsremote.ESAPI.Validator.DirectoryName | regex for a valid directory name |
rsremote.ESAPI.Validator.FileName | regex for a valid file name |
rsremote.ESAPI.Validator.HTTPContextPath | regex for a valid http context path |
rsremote.ESAPI.Validator.HTTPCookieName | regex for a valid cookie name |
rsremote.ESAPI.Validator.HTTPCookieValue | regex for a valid cookie value |
rsremote.ESAPI.Validator.HTTPHeaderName | regex for a valid http header name |
rsremote.ESAPI.Validator.HTTPHeaderValue | regex for a valid http header value |
rsremote.ESAPI.Validator.HTTPJSESSIONID | regex for a valid http JSESSIONID |
rsremote.ESAPI.Validator.HTTPParameterName | regex for a valid http parameter name |
rsremote.ESAPI.Validator.HTTPParameterValue | regex for a valid http parameter value |
rsremote.ESAPI.Validator.HTTPPath | regex for a valid http path |
rsremote.ESAPI.Validator.HTTPQueryString | regex for a valid http query string |
rsremote.ESAPI.Validator.HTTPServletPath | regex for a valid http servlet path |
rsremote.ESAPI.Validator.HTTPScheme | regex for a valid http scheme |
rsremote.ESAPI.Validator.HTTPServerName | regex for a valid http server name |
rsremote.ESAPI.Validator.HTTPURI | regex for a valid http uri |
rsremote.ESAPI.Validator.HTTPURL | regex for a valid http url |
rsremote.ESAPI.Validator.Redirect | regex for a valid redirect |
rsremote.ESAPI.Validator.RoleName | regex for a valid rolename |
rsremote.ESAPI.Validator.SystemCommand | regex for a valid System Command |
Property Name | Default Value |
---|
rssync.ESAPI.AccessControl | Class used for access control. |
Property Name | Default Value |
---|
rssync.ESAPI.Authenticator | Class used for ESAPI authenticator. |
rssync.ESAPI.Authenticator.AllowedLoginAttempts | Maximum allowed login attempts. |
rssync.ESAPI.Authenticator.MaxOldPasswordHashes | Maximum amount of old password hashes allowed. |
rssync.ESAPI.Authenticator.UsernameParameterName | Parameter name for the username in the ESAPI authenticator. |
rssync.ESAPI.Authenticator.PasswordParameterName | Parameter name for the password in the ESAPI authenticator. |
rssync.ESAPI.Authenticator.RememberTokenDuration | Period of time to remember an authentication token. |
rssync.ESAPI.Authenticator.IdleTimeoutDuration | Period of time a user can be idle before timeout. |
rssync.ESAPI.Authenticator.AbsoluteTimeoutDuration | Period of time until a token times out. |
Property Name | Default Value |
---|
rssync.ESAPI.Encoder | Class used for encoding. |
rssync.ESAPI.Encoder.AllowMultipleEncoding | Set to 'true' to allow multiple encoding. |
rssync.ESAPI.Encoder.DefaultCodecList | List of encoders used by default. |
Property Name | Default Value |
---|
rssync.ESAPI.Encryptor.PreferredJCEProvider | Preferred JCEProvider. |
rssync.ESAPI.Encryptor.EncryptionAlgorithm | Encryption algorithmn used. |
rssync.ESAPI.Encryptor.CipherTransformation | Cipher transformation used to encrypt. |
rssync.ESAPI.Encryptor.cipher_modes.combined_modes | Modes that support confidentiality and authenticity. |
rssync.ESAPI.Encryptor.cipher_modes.additional_allowed | Ciphers allowed in addition to the ones in combined_modes. |
rssync.ESAPI.Encryptor.EncryptionKeyLength | The number of bits in a key used by a cryptographic algorithm. |
rssync.ESAPI.Encryptor | Class used for encryption. |
rssync.ESAPI.Encryptor.ChooseIVMethod | Method of generating initialization vector. |
rssync.ESAPI.Encryptor.fixedIV | Initialization vector to use if fixed IV method is chosen |
rssync.ESAPI.Encryptor.CipherText.useMAC | If 'true 'compute and store the MAC. |
rssync.ESAPI.Encryptor.PlainText.overwrite | First overwrite the bytes of plaintext with the character. |
rssync.ESAPI.Encryptor.HashAlgorithm | Algorithm used to generate the encryption hash. |
rssync.ESAPI.Encryptor.HashIterations | Number of steps to take when hashing. |
rssync.ESAPI.Encryptor.DigitalSignatureAlgorithm | Algorithm used to generate a digital signature |
rssync.ESAPI.Encryptor.DigitalSignatureKeyLength | The number of bits in a key used by a cryptographic algorithm. |
rssync.ESAPI.Encryptor.RandomAlgorithm | Algorithm used to generate a random number. |
rssync.ESAPI.Encryptor.CharacterEncoding | Character encoding used. |
rssync.ESAPI.Encryptor.KDF.PRF | Psuedo random function used in KDF. |
Property Name | Default Value |
---|
rssync.ESAPI.Executor | Class used to execute os commands. |
rssync.ESAPI.Executor.WorkingDirectory | Directory in which commands are executed. |
rssync.ESAPI.Executor.ApprovedExecutables | List of approved executable files. |
Property Name | Default Value |
---|
rssync.ESAPI.HTTPUtilities | Class used for securing http requests, responses, sessions, cookies, headers, and logging. |
rssync.ESAPI.HttpUtilities.UploadDir | Directory for files upload. |
rssync.ESAPI.HttpUtilities.UploadTempDir | Directory for temporary files upload. |
rssync.ESAPI.HttpUtilities.ForceHttpOnlySession | Set to 'true' to force the http only flag be set on the session. |
rssync.ESAPI.HttpUtilities.ForceSecureSession | Set to 'true' to force the secure session only flag to be set the session. |
rssync.ESAPI.HttpUtilities.ForceHttpOnlyCookies | Set to 'true' to force the http only flag to be set on cookies. |
rssync.ESAPI.HttpUtilities.ForceSecureCookies | Set to 'true' to force the secure only flag to be set on cookies. |
rssync.ESAPI.HttpUtilities.MaxHeaderSize | Maximum size of header. |
rssync.ESAPI.HttpUtilities.ApprovedUploadExtensions | Extensions allowed for upload. |
rssync.ESAPI.HttpUtilities.MaxUploadFileBytes | Maximum upload size for a file in bytes. |
rssync.ESAPI.HttpUtilities.ResponseContentType | The content type of the response and its character encoding. |
rssync.ESAPI.HttpUtilities.HttpSessionIdName | Name of the http session. |
Property Name | Default Value |
---|
rssync.ESAPI.IntrusionDetector.Disable | Set to 'true' to disable intrusion detection. |
rssync.ESAPI.IntrusionDetectorC | Class used for intrusion detection. |
rssync.ESAPI.IntrusionDetector.event.test.actions | Action to take if an intrusionexception fires. |
rssync.ESAPI.IntrusionDetector.event.test.count | Fire off intrusion exception if count events are received within an interval. |
rssync.ESAPI.IntrusionDetector.event.test.interval | Interval in which count actions are allowed. |
rssync.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.actions | Action to take if an integrityException fires. |
rssync.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.count | Fire off IntegrityException if count events are received within an interval. |
rssync.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.interval | Interval in which count actions are allowed. |
rssync.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.actions | Action to take if an IntrusionException fires. |
rssync.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.count | Fire off intrusion exception if count events are received within an interval. |
rssync.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.interval | Interval in which count actions are allowed. |
rssync.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.count | Fire off AuthenticationHostException if count events are received within an interval. |
rssync.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.interval | Interval in which count actions are allowed. |
rssync.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.actions | Action to take if an AuthenticationHostException fires. |
Property Name | Default Value |
---|
rssync.ESAPI.Logger | Logger factory used to create a logger. |
rssync.ESAPI.Logger.ApplicationName | Name of the application being logged for. |
rssync.ESAPI.Logger.LogApplicationName | Determines whether ESAPI should log the application name. |
rssync.ESAPI.Logger.LogEncodingRequired | Set to 'true' to require log data to be encoded. |
rssync.ESAPI.Logger.LogFileName | Name of file to log into. |
rssync.ESAPI.Logger.MaxLogFileSize | Max log file size. |
rssync.ESAPI.Logger.LogServerIP | Log the server IP when logging. |
Property Name | Default Value |
---|
rssync.ESAPI.printProperties | If 'true' print all ESAPI properties when loaded. |
RSsync ESAPI Randomizer
Property Name | Default Value |
---|
rssync.ESAPI.Randomizer | Class used for creating random numbers. |
Property Name | Default Value |
---|
rssync.ESAPI.Validator | Class used for validation. |
rssync.ESAPI.Validator.AcceptLenientDates | Set to 'true' to accept lenient dates' |
rssync.ESAPI.Validator.AccountName | regex for allowed chracters and length for an account name |
rssync.ESAPI.Validator.ConfigurationFile | Name of the config file for validation' |
rssync.ESAPI.Validator.DirectoryName | regex for a valid directory name |
rssync.ESAPI.Validator.FileName | regex for a valid file name |
rssync.ESAPI.Validator.HTTPContextPath | regex for a valid http context path |
rssync.ESAPI.Validator.HTTPCookieName | regex for a valid cookie name |
rssync.ESAPI.Validator.HTTPCookieValue | regex for a valid cookie value |
rssync.ESAPI.Validator.HTTPHeaderName | regex for a valid http header name |
rssync.ESAPI.Validator.HTTPHeaderValue | regex for a valid http header value |
rssync.ESAPI.Validator.HTTPJSESSIONID | regex for a valid http JSESSIONID |
rssync.ESAPI.Validator.HTTPParameterName | regex for a valid http parameter name |
rssync.ESAPI.Validator.HTTPParameterValue | regex for a valid http parameter value |
rssync.ESAPI.Validator.HTTPPath | regex for a valid http path |
rssync.ESAPI.Validator.HTTPQueryString | regex for a valid http query string |
rssync.ESAPI.Validator.HTTPServletPath | regex for a valid http servlet path |
rssync.ESAPI.Validator.HTTPScheme | regex for a valid http scheme |
rssync.ESAPI.Validator.HTTPServerName | regex for a valid http server name |
rssync.ESAPI.Validator.HTTPURI | regex for a valid http uri |
rssync.ESAPI.Validator.HTTPURL | regex for a valid http url |
rssync.ESAPI.Validator.Redirect | regex for a valid redirect |
rssync.ESAPI.Validator.RoleName | regex for a valid rolename |
rssync.ESAPI.Validator.SystemCommand | regex for a valid System Command |
RSview ESAPI Access Contro
Property Name | Default Value |
---|
rsview.ESAPI.AccessControl | Class used for access control. |
RSview ESAPI Authentification
Property Name | Default Value |
---|
rsview.ESAPI.Authenticator | Class used for ESAPI authenticator. |
rsview.ESAPI.Authenticator.AllowedLoginAttempts | Maximum allowed login attempts. |
rsview.ESAPI.Authenticator.MaxOldPasswordHashes | Maximum amount of old password hashes allowed. |
rsview.ESAPI.Authenticator.UsernameParameterName | Parameter name for the username in the ESAPI authenticator. |
rsview.ESAPI.Authenticator.PasswordParameterName | Parameter name for the password in the ESAPI authenticator. |
rsview.ESAPI.Authenticator.RememberTokenDuration | Period of time to remember an authentication token. |
rsview.ESAPI.Authenticator.IdleTimeoutDuration | Period of time a user can be idle before time out. |
rsview.ESAPI.Authenticator.AbsoluteTimeoutDuration | Period of time until a token times out. |
RSview ESAPI Encoder
Property Name | Default Value |
---|
rsview.ESAPI.Encoder | Class used for encoding. |
rsview.ESAPI.Encoder.AllowMultipleEncoding | Set to 'true' to allow multiple encoding. |
rsview.ESAPI.Encoder.DefaultCodecList | List of encoders used by default. |
RSview ESAPI Encryptor
Property Name | Default Value |
---|
rsview.ESAPI.Encryptor.PreferredJCEProvider | Preferred JCEProvider. |
rsview.ESAPI.Encryptor.EncryptionAlgorithm | Encryption algorithmn used. |
rsview.ESAPI.Encryptor.CipherTransformation | Cipher transformation used to encrypt. |
rsview.ESAPI.Encryptor.cipher_modes.combined_modes | Modes that support confidentiality and authenticity. |
rsview.ESAPI.Encryptor.cipher_modes.additional_allowed | Ciphers allowed in addition to the ones in combined_modes. |
rsview.ESAPI.Encryptor.EncryptionKeyLength | The number of bits in a key used by a cryptographic algorithm. |
rsview.ESAPI.Encryptor | Class used for encryption. |
rsview.ESAPI.Encryptor.ChooseIVMethod | Method of generating initialization vector. |
rsview.ESAPI.Encryptor.fixedIV | Initialization vector to use if fixed IV method is chosen. |
rsview.ESAPI.Encryptor.CipherText.useMAC | If 'true' compute and store the MAC. |
rsview.ESAPI.Encryptor.PlainText.overwrite | First overwrite teh bytes of plaintext with the character. |
rsview.ESAPI.Encryptor.HashAlgorithm | Algorithm used to generate the encryption hash. |
rsview.ESAPI.Encryptor.HashIterations | Number of steps to take when hashing. |
rsview.ESAPI.Encryptor.DigitalSignatureAlgorithm | Algorithm used to generate a digital signature. |
rsview.ESAPI.Encryptor.DigitalSignatureKeyLength | The number of bits in a key used by a cryptographic algorithm. |
rsview.ESAPI.Encryptor.RandomAlgorithm | Algorithm used to generate a random number. |
rsview.ESAPI.Encryptor.CharacterEncoding | Character encoding used. |
rsview.ESAPI.Encryptor.KDF.PRF | Psuedo random function used in KDF. |
RSview ESAPI Executor
Property Name | Default Value |
---|
rsview.ESAPI.Executor | Class used to execute os commands. |
rsview.ESAPI.Executor.WorkingDirectory | Directory in which commands are executed. |
rsview.ESAPI.Executor.ApprovedExecutables | Lis of approved executable files. |
RSview ESAPI HTTPUtilities
Property Name | Default Value |
---|
rsview.ESAPI.HTTPUtilities | Class used for securing http requests, responses, sessions, cookies, headers, and logging. |
rsview.ESAPI.HttpUtilities.UploadDir | Directory to uploaded files. |
rsview.ESAPI.HttpUtilities.UploadTempDir | Directory to upload temporary files. |
rsview.ESAPI.HttpUtilities.ForceHttpOnlySession | Set to 'true' to force the http only flag be set on the session. |
rsview.ESAPI.HttpUtilities.ForceSecureSession | Set to 'true' to force the secure session only flag to be set the session. |
rsview.ESAPI.HttpUtilities.ForceHttpOnlyCookies | Set to 'true' to force the http only flag to be set on cookies. |
rsview.ESAPI.HttpUtilities.ForceSecureCookies | Set to 'true' to force the secure only flag to be set on cookies. |
rsview.ESAPI.HttpUtilities.MaxHeaderSize | Maximum size of header. |
rsview.ESAPI.HttpUtilities.ApprovedUploadExtensions | Extensions allowed for upload. |
rsview.ESAPI.HttpUtilities.MaxUploadFileBytes | Maximum upload size for a file in bytes. |
rsview.ESAPI.HttpUtilities.ResponseContentType | The content type of the response and its character encoding. |
rsview.ESAPI.HttpUtilities.HttpSessionIdName | Name of the http session. |
rsview.ESAPI.IntrusionDetector.Disable | Set to 'true' to disable intrusion detection. |
rsview.ESAPI.IntrusionDetector | Class used for intrusion detection. |
rsview.ESAPI.IntrusionDetector.event.test.actions | Action to take if an intrusionexception fires. |
rsview.ESAPI.IntrusionDetector.event.test.count | Fire off intrusion exception if count events are received within an interval. |
rsview.ESAPI.IntrusionDetector.event.test.interval | Interval in which count actions are allowed. |
rsview.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.actions | Action to take if an integrityException fires. |
rsview.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.count | Fire off IntegrityException if count events are received within an interval. |
rsview.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.interval | Interval in which count actions are allowed. |
rsview.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.actions | Action to take if an IntrusionException fires. |
rsview.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.count | Fire off intrusion exception if count events are received within an interval. |
rsview.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.interval | Interval in which count actions are allowed. |
rsview.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.count | Fire off AuthenticationHostException if count events are received within an interval. |
rsview.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.interval | Interval in which count actions are allowed. |
rsview.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.actions | Action to take if an AuthenticationHostException fires. |
RSview ESAPI Logger
Property Name | Default Value |
---|
rsview.ESAPI.Logger | Logger factory used to create a logger. |
rsview.ESAPI.Logger.ApplicationName | Name of the application being logged for. |
rsview.ESAPI.Logger.LogApplicationName | Determines whether ESAPI should log the application name. |
rsview.ESAPI.Logger.LogEncodingRequired | Set to 'true' to require log data to be encoded. |
rsview.ESAPI.Logger.LogFileName | Name of file to log into. |
rsview.ESAPI.Logger.MaxLogFileSize | Max log file size. |
rsview.ESAPI.Logger.LogServerIP | Log the server ip when logging. |
RSview ESAPI printProperties
Property Name | Default Value |
---|
rsview.ESAPI.printProperties | If 'true' print all ESAPI properties when loaded. |
RSview ESAPI Randomizer
Property Name | Default Value |
---|
rsview.ESAPI.Randomizer | Class used for creating random numbers. |
RSview ESAPI Validator
Property Name | Default Value |
---|
rsview.ESAPI.Validator | Class used for validation. |
rsview.ESAPI.Validator.AcceptLenientDates | Set to 'true' to accept lenient dates. |
rsview.ESAPI.Validator.AccountName | regex for allowed chracters and length for an account name |
rsview.ESAPI.Validator.ConfigurationFile | Name of the config file for validation. |
rsview.ESAPI.Validator.DirectoryName | regex for a valid directory name |
rsview.ESAPI.Validator.FileName | regex for a valid file name |
rsview.ESAPI.Validator.HTTPContextPath | regex for a valid http context path |
rsview.ESAPI.Validator.HTTPCookieName | regex for a valid cookie name |
rsview.ESAPI.Validator.HTTPCookieValue | regex for a valid cookie value |
rsview.ESAPI.Validator.HTTPHeaderName | regex for a valid http header name |
rsview.ESAPI.Validator.HTTPHeaderValue | regex for a valid http header value |
rsview.ESAPI.Validator.HTTPJSESSIONID | regex for a valid http JSESSIONID |
rsview.ESAPI.Validator.HTTPParameterName | regex for a valid http parameter name |
rsview.ESAPI.Validator.HTTPParameterValue | regex for a valid http parameter value |
rsview.ESAPI.Validator.HTTPPath | regex for a valid http path |
rsview.ESAPI.Validator.HTTPQueryString | regex for a valid http query string |
rsview.ESAPI.Validator.HTTPServletPath | regex for a valid http servlet path |
rsview.ESAPI.Validator.HTTPScheme | regex for a valid http scheme |
rsview.ESAPI.Validator.HTTPServerName | regex for a valid http server name |
rsview.ESAPI.Validator.HTTPURI | regex for a valid http uri |
rsview.ESAPI.Validator.HTTPURL | regex for a valid http url |
rsview.ESAPI.Validator.Redirect | regex for a valid redirect |
rsview.ESAPI.Validator.RoleName | regex for a valid rolename |
rsview.ESAPI.Validator.SystemCommand | regex for a valid System Command |
Groovy Sandboxing Parameters
Detailed usage description and configurations steps to be found in Security Considerations.
Property Name | Description | Default value |
---|
rscontrol.groovy.sandbox.enable | When set to true it is enabled | false |
rscontrol.groovy.sandbox.location | | {DIST}/rscontrol/config |
rsremote.groovy.sandbox.enable | When set to true it is enabled | false |
rsremote.groovy.sandbox.location | | {DIST}/rsremote/config |
rsview.groovy.sandbox.enable | When set to true it is enabled | false |
rsview.groovy.sandbox.location | | {DIST}/tomcat/webapps/resolve/WEB-INF |
rsconsole.groovy.sandbox.enable | When set to true it is enabled | false |
rsconsole.groovy.sandbox.location | | {DIST}/rsconsole/config |
rsmgmt.groovy.sandbox.enable | When set to true it is enabled | false |
rsmgmt.groovy.sandbox.location | | {DIST}/rsmgmt/config |
rssync.groovy.sandbox.enable | When set to true it is enabled | false |
rssync.groovy.sandbox.location | | {DIST}/rssync/config |
rsarchive.groovy.sandbox.enable | When set to true it is enabled | false |
rsarchive.groovy.sandbox.location | | {DIST}/rsarchive/config |
Persistent Connections and the SESSIONS Object
Most data can be transferred from the RSRemote back to the RSControl. INPUTS can be used to move lists, maps, or other non-string objects between the Content and the Assessor. However, connections and other non-serializable objects cannot be moved between components. Actions Pro provides a SESSIONS object that allows an object to be "saved" or "persisted" on an RSRemote. Follwoing tasks that need to access this object will be executed on that RSRemote.
Persisting a Connection
The SESSIONS object is employed to retain an open connection (a "session") that is used by multiple tasks. This way is evaded the need to open and close the
connection in each task, and improves modularity and reusability of Action Tasks. The workflow for persisting a connection is:
- Open a connection and save it to SESSIONS
- Execute commands using saved connection.
- Close the connection and clear the SESSIONS.
The SESSIONS binding is only available during automation execution. If you try to execute a task using SESSIONS outside of a Runbook (for example, while testing), then an exception will be thrown. Also, note that SESSIONS is a reserved variable name. The mechanics for persisting a connection are:
- Place an object (named "conn" in this example) into SESSIONS using the following SESSIONS.put() code. The object is kept in memory on the JVM and sets a session affinity for that RSRemote.
- Later tasks using the SESSIONS object will execute on the same RSRemote. Retrieve the object using SESSIONS.get(). The affinity is stored in FLOWS. SESSIONS are unique to an execution path, and may no longer be available after a merge. If not working correctly, check FLOWS values in rscontrol.log.
Def conn = SESSIONS.get();
- When you are finished, remove the affinity with SESSIONS.remove():
Other Uses
The use of the SESSIONS object is not restricted to Actions Pro Connectors. It can be used with other Groovy objects that are not serializable. Web and database connections are good candidates, although using SESSIONS witch HTMLUnit, depending on the target page, can sometimes cause errors.
The SESSIONS object can also be used in cases where an object does not need to be persisted, but tasks need to be executed on the same RSRemote. Such situations may occur when the task needs to access a particular file on the file system.
To establish a session affinity without an object, call:
Note that only tasks that contain the string "SESSIONS" will use the affinity, so be sure to add the string in a comment.
Always remember to clear the session when affinity is no longer needed. Also remember that the SESSIONS object, since it is maintained using FLOWS, mightnotpersist after a merge.